План документации — это документ, написанный техническими писателями (обычно, тим лидами или руководителями проекта), который помогает сформулировать детали предстоящей работы. Он помогает структурировать все процессы внутри команды и предоставляет всем доступ к важной информации.
План документации может включать различные элементы. Вот что обычно включают в такие планы в большинстве компаний:
- Название проекта
- Объем и цели
- Подробный контент-план
- Оценка времени
- Ответственные лица
- Рабочий процесс
- Ресурсы (программное обеспечение, стилистические руководства, веб-сайты)
- Детали публикации (форматы, способы доставки конечным пользователям)
Написание таких планов помогает предсказать возможные узкие места и предотвратить проблемы, которые могут возникнуть в процессе реализации проекта.
Рекомендуется составлять такие планы перед каждой крупной итерацией документации. Это особенно важно, когда появляется совершенно новый проект документации.
Также такие планы можно использовать при тестировании новых схем рабочих процессов. Поскольку все исходные данные уже написаны и организованы, будет легче управлять ими и анализировать результаты, когда вы вернетесь с результатами пилотного тестирования.
План документации пишется на этапе подготовки создания руководства пользователя.