Общая информация
Документация принадлежит к типу программной и эксплуатационной. Объединяет в себе пакеты документов программы, комплекса и его программных компонентов. Создается для программистов-создателей программы и тех программистов, работающих с данным программным продуктом или разрабатывающих новые продукты на базе данного.
Целью документации является предоставление программистам возможностей для решения задач, поставленных для данной программы. Все документы соответствуют стандартам: ГОСТ 19.504-79.
Предмет и применение
Руководство для программистов разрабатывается если:
1. Создаваемая программа предназначена для области разработки или библиотеки.
2. Создаваемая программа становится основой для разработки программ и систем конкретного вида.
3. Распространение программного продукта происходит вместе с исходным кодом или она нуждается в постоянной модификации.
Бывают и другие случаи, требующие разработки руководства для программиста, но они являются единичными.
Основной целью руководства является обеспечение программиста-разработчика сведениями для написания собственной программы на базе данной.
Содержание
- Устройство и конструкция программы: ее части, местоположение, время существования, взаимодействие.
- Перечень требуемых средств разработки для описания приложения (системы).
- Область действия приложения (системы), требования к ней, дополняющие программные средства.
- Работоспособность системы (приложения), последовательность создания необходимых объектов и принцип их взаимодействия.
- Пошаговое разворачивание действующей системы (приложения).
Также руководство для программиста дополняется описанием нужных в данной программе объектов. В случае использования в данной программе оригинального языка, необходимо включить и его описание.
Методология и язык написания
Главное - логичность и порядок изложения. Необходимо, чтобы текст соответствовал следующим правилам:
- Появление нового определения должно базироваться на уже известных ранее;
- Появление всех понятий должно быть целесообразным и обоснованным.
При описании отдельных объектов главное внимание уделяется:
- описание всего, что происходит до создания и применения объекта;
- способы восприятия объектом поступаемых сведений;
- местоположение объекта.
Описание всех объектов чаще всего объединяют в «Справочник программиста».
Стандартная структура - согласно ГОСТ 19.504-79.
1. Назначение и условия применения программы.
2. Характеристика программы.
3. Обращение к программе.
4. Входные и выходные данные.
5. Сообщения.
