Наименование документа на русском языке | Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению |
---|---|
Наименование документа на английском языке | Unified system for program documentation. Programmer's guide. Requirements for contents and form of presentation |
Статус документа | Действует |
Дата ввода в действие документа | 01.01.1980 |
Дата последнего издания документа | 04.03.2010 |
Код КГС | Т55 |
Код ОКСТУ | 5004;0019 |
Настоящий стандарт устанавливает требования к содержанию и оформлению программного документа «Руководство программиста», определенного ГОСТ 19.101-77.
Стандарт полностью соответствует СТ СЭВ 2095-80.
1.1. Структура и оформление документа устанавливаются в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным.
1.2. Руководство программиста должно содержать следующие разделы:
В зависимости от особенностей документа допускается объединять отдельные разделы или вводить новые.
2.1. В разделе «Назначение и условия применения программы» должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т. п.).
2.2. В разделе «Характеристики программы» должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т. п.).
2.3. В разделе «Обращение к программе» должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
2.4. В разделе «Входные и выходные данные» должно быть приведено описание организации используемой входной и выходной информации и, при необходимости, ее кодирования.
2.5. В разделе «Сообщения» должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.
2.6. В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т. п.).