Technical Writing and Documentation

Technical writing can include a broad range of technical topics, including STEM disciplines, biology, pharmacy, and others. My main focus is on IT topics, especially software and IT service management processes as well as business processes.

The technical writing process consisting of the phases requirements, outline and plan, development, review and editing, and delivery

Technical Writing Formats

The documentation or user guide can be delivered in different file formats, for instance

  • Microsoft Word (.docx)
  • .pdf
  • .xml / DITA
  • Markdown (.md)
  • HTML

The text can also be written on your website or in your content management system.

Software Documentation

  • Have you customized a software and the standard documentation doesn’t explain all your new features? Do you need documentation for your customized software?
  • Have you developed a software product? Do you need a user guide that explains it to your customers?
  • Do you already have software documentation, but it’s incomplete, error-prone, outdated, not well structured, or not clearly written? Do you want to improve your documentation, to decrease the ticket number of your technical support/service desk?

Process Documentation

  • Do you want to introduce or change IT service management processes in your company and you need detailed documentation?
  • Have you already introduced or changed a process, but you don’t have complete documentation yet?
  • Have you introduced or changed business processes in your company and you need documentation?
  • Or do you plan any process change and need documentation?
  • Do you have several process documentations but you want to have them in a consistent format, structure, or language?

Website Content, Knowledge Base Content, and Product Descriptions

  • Do you have a website and need content like blog articles, marketing texts, or product descriptions for your online shop?
  • Do you have a knowledge base, but your service desk employees have no time to document the ticket solution in it?
  • Do you need another type of technical writing not mentioned here?

Software Requirements

  • Do you want to start an IT project, but you don’t have documented your requirements yet?
  • Do you need someone to assist you in documenting your software requirements? Do you need user stories for your agile project, but have no time or resources for it?

Next steps to start your project

The first step is to contact me. Just send me an email with a short description of your project. We can then schedule an appointment for a phone call or virtual meeting to talk about your requirements. Finally, you will get an individual offer for the service and if you accept it, the project can start!