Процессы
Подготовка к документированию: читаем ТЗ, собираем информацию
Доклад планируется на конференции TechWriter Days 3 и появится в общей программе на странице Доклады.
В этом докладе я хочу рассказать о самом непростом, с моей точки зрения, этапе процесса документирования: сборе информации и подготовке к написанию документации. Как правило, при постановке задачи на документирование нам предоставляется техническое задание. Я расскажу, как быстрее разобраться в нем и использовать информацию из него для документирования: разбить на смысловые блоки, разобраться в терминах и преобразовать содержимое так, чтобы оно подходило для конечного пользователя. Также иногда бывают задачи, по которым вовсе нет ТЗ. Расскажу, где в этом случае искать нужную информацию и кому и как задавать вопросы. Доклад предназначен для всех, кто пишет документацию – от начинающих до опытных техписателей.