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