Как писать документацию к программному обеспечению


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

Разновидностей подобной документации множество: это и спецификации и методики тестирования, и тексты программ, и руководства и всевозможные справки для пользователя. Для удобного использования подобной документации она должна быть кратка по объему, актуальна по содержанию, полна по смыслу.

Существуют два способа написания технической документации.

Способ 1. Написание технической документации для специалистов.

1. Определение необходимой информации. Такая документация будет использоваться специалистами (программистами, разработчиками интерфейса), а значит должная содержать точные сведения по программе. Также могут включаться:
- главные файлы приложения, которые создают разработчики, базы данных, утилиты прочих программ,
- подпрограммы и функции с объяснением назначения каждой из них,
- константы и переменные продукта с указанием способа их применения,
- единая структура программного продукта.

2. Сортировка документации по принципу включения в программный код и создание отдельных документов. Максимальное включение документации в код программы облегчают обновление и сопровождение программного продукта.

3. Инструмент для документирования. Определяется языком, на котором создается данный программный продукт и типом требуемых документов.

Способ 2. Написание технической документации для конечных пользователей.

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

2. Определение целевой аудитории. Достаточно редко широкий круг пользователей является специалистами в какой-то конкретной области. Для выделения целевой аудитории:

- определите круг должностей сотрудников, которые будут работать с программным приложением,

- постарайтесь познакомиться с этими людьми и создать свое представление об уровне их подготовки,

- главным в написании технической программы поставьте ответ на вопрос, что может дать данный продукт конкретному пользователю.

3. Выберите формат подачи данных при написании технической документации. Обычно это или справочное руководство, или руководство пользователя.

4. Выберите форму для документов (различные справки, PDF-файлы, печатные руководства и т.д.).

5. Выберите удобный инструмент документирования (программное обеспечение).


Если у вас возникли вопросы обратитесь к нашим экспертам и получите грамотную консультацию.
Tehpis.ru