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

Note

“Руководство программиста” - это документ, который помогает программистам понять, как правильно работать с программой и поддерживать ее.

Справочная информация#

Структура и содержание документа#

  • Лист утверждения

  • Титульный лист

  • Аннотация

  • Содержание
    • Назначение и условия применения программ

      • Назначение программы

      • Функции, выполняемые программой

      • Условия, необходимые для выполнения программы

        • Объем оперативной памяти

        • Требования к составу периферийных устройств

        • Требования к параметрам периферийных устройств

        • Требования к программного обеспечению

        • Требования к персоналу (программисту)

    • Характеристика программы
      • Описание основных характеристик программы

        • Временные характеристики программы

        • Режим работы программы

      • Средства контроля правильности выполнения программы

        • Описание основных особенностей программы

        • Самовосстанавливаемость программы

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

      • Загрузка и запуск программы

      • Выполнение программы

        • Выполнение функции 1

        • Выполнение функции 2

      • Завершение работы программы

    • Входные и выходные данные

      • Организации используемой входной информации

      • Организации используемой выходной информации

    • Сообщения

      • Сообщение 1

      • Сообщение 2

  • Приложения (необязательно)

  • Регистрация изменений