Documentat.io

Об основах профессии технического писателя: о том, какая документация необходима в IT-проектах, о том, как ее писать, и о том, как делать это качественно.

• Для тех, кто интересуется профессией технического писателя или системного аналитика

• Для тех, кто уже работает техписателем или аналитиком, но хочет повысить свою квалификацию

• Для тех, кому необходимо заниматься технической документацией в дополнение к своим основным служебным обязанностям (да, разработчикам тоже иногда приходится писать документацию).

• Задачи, решаемые технической документацией. Зачем она нужна? Каково ее место в процессе разработки ПО?

• Жанры технических документов (технические задания, спецификации, архитектурные документы, инструкции по интеграции, пользовательские инструкции...). Структура и содержимое типичных документов.

• Техническая стилистика. Правила подачи информации в технических документах, грамматические и оформительские особенности технического текста.

• Индустриальные стандарты технической документации.

• Документ как проект. Жизненный цикл документа, требования к документу, его качество, процесс приемки документа. Что требовать от руководства перед началом работы над документом.

• Место технического писателя в проекте, его взаимодействие с другими членами проектной команды.

• Профессиональный рост технического писателя.

• Обзор рынка труда документационных специалистов.

В рамках курса вы сможете написать несколько настоящих технических документов под контролем преподавателя (а затем включить их в свое профессиональное портфолио и, например, предъявить их на собеседовании).

Кроме того, мы разыграем несколько реальных проектных ситуаций, связанных с документацией, в формате деловых игр: создание документа от постановки задачи до приемки, выяснение требований у заказчика и написание на их основе спецификации, и т.д.