ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению

Руководство программиста должно содержать разделы:

1. Назначение и условия применения программы.

2. Характеристики программы.

3. Обращение к программе.

4. Входные и выходные данные.

5. Сообщения.

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

В разделе Характеристики программы необходимо привести описание основных характеристик и особенностей программы: временных характеристик, режима работы, средств контроля правильности выполнения и самовосстанавливаемости программы и т.д.

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

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

При описании сообщений необходимо привести тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.

Средство документирования - это предмет (орудие) или совокупность приспособлений (оборудование, инструменты), используемых для создания документа (ручные, механизированные и автоматизированные приспособления). Обычно средства документирования встроены в конкретные CASE-средства. Исключением являются некоторые пакеты, предоставляющие дополнительный сервис при документировании. Из них наиболее активно используется SoDA (Software Document Аutomation). Продукт SoDA предназначен для автоматизации разработки проектной документации на всех фазах ЖЦ ПО. Он позволяет автоматически извлекать разнообразную информацию, получаемую на разных стадиях разработки проекта, и включать ее в выходные документы. При этом контролируется соответствие документации проекту, взаимосвязь документов, обеспечивается их своевременное обновление.