Документирование программных изделий ЕСПД


Руководство программиста


Аннотация и содержание обязательны.

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

  • Назначение и условия применения - назначение и функции, условия, необходимые для выполнения (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению).
  • Характеристики программы - описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.)..
  • Обращение к программе - описание процедур вызова программы (способы передачи управления и параметров данных и др.).
  • Входные и выходные данные - описание организации входной и выходной информации и, при необходимости, ее кодирования.
  • Сообщения -тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В зависимости от особенностей документа допускается объединять отдельные разделы и вводить новые.

В приложении к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).

Перечень документов


Начало  Назад  Вперед



Книжный магазин