ДОКУМЕНТИРОВАНИЕ ПРОГРАММНОГО ПРОДУКТА.
Программный продукт ( ПП ), разработанный в рамках выпускной квалификационной работы должен сопровождаться следующей документацией:
| Техническое задание 19.201-78
| Введение
| Наименование, краткая характеристика области применения ПП и объекта, в котором используют ПП
|
|
| Основания для разработки
| Документ(ы), на соновании которых ведется разработка; организация, утвердившая этот документ, и дата его утверждения; наименование темы разработки.
|
|
| Назначение разработки
| Функциональное и эксплуатационное назначение ПП
|
|
| Требования к ПП
| Требования к функциональным характеристикам, надежности, составу и параметрам технических средств, информационной и программной совместимости
|
|
| Требования к программной документации
| Предварительный состав программной документации
|
| Руководство системного программиста 19.502.-78
| Общие сведения о программе
| Назначение и функции программы, сведения о технических и программных средствах, обеспечивающих выполнение программы
|
|
| Структура программы
| Сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами
|
|
| Настройка программы
| Описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.)
|
|
| Проверка программы
| Описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, результаты)
|
|
| Дополнительные возможности
| описание дополнительных разделов функциональных возможностей программы и способов их выбора
|
|
| Сообщения системному программисту
| Тексты сообщений, выдаваемых в ходе выполнения, настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим соображениям
|
| Руководство программиста
| Назначение и условия применения
| Назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.)
|
|
| Характеристики программы
| Описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
|
|
| Обращение к программе
| Описание процедур вызова программы (способы передачи управления и параметров данных и др.)
|
|
| Входные и выходные данные
| Описание организации используемой входной и выходной информации и при необходимости, ее кодирования
|
|
| Сообщения
| Тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям
|
| Руководство пользователя 19.105-78
| Назначение программы
| Сведения о назначении программы и информация, достаточная для понимания функций программы и ее эксплуатации
|
|
| Условия выполнения программы
| Условия, необходимые для выполнения программы (минимальный и (или) максимальный состав аппаратных и программных средств и т.п.)
|
|
| Выполнение программы
| Последовательность действий оператора, обеспечивающих загрузку, выполнение и завершение программы, описание функций, формат и возможные варианты команд, с помощью которых оператор осуществляет загрузку и управляет выполнением программы, а также ответы программы на эти команды
|
|
| Сообщения оператору
| Тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора (действия оператора в случае сбоя, возможности повторного запуска программы и т.п.)
|
В документацию по ПО разрешается добавлять новые пункты, отражающие специфику программ.