Preparing for Documentation: Reading the Specification and Gathering Information

  • 20 min

In this talk, I want to discuss the most difficult stage of the documentation process from my perspective: gathering information and preparing for writing documentation. 

Typically, when a documentation task is assigned, we receive a technical specification. I will explain how to quickly understand it and use the information from it for documentation: break it down into semantic blocks, understand the terms and transform the content so that it is suitable for the end user. 

Moreover, sometimes there are tasks with no technical specifications at all. I will describe where to look for the necessary information in such cases, and whom and how to ask the right questions.

The talk is intended for everyone involved in writing documentation, from beginners to experienced technical writers.

Comments ({{Comments.length}})
  • {{comment.AuthorFullName}}
    {{comment.AuthorInfo}}
    {{ comment.DateCreated | date: 'dd.MM.yyyy' }}

To leave a feedback you need to

or
Chat with us, we are online!