ГОСТ 19.101-77
Виды программных документов
Обзорная полка документов ЕСПД — что за чем стоит.
Ниже — учебный путеводитель по видам. Официальные таблицы смотри в стандарте; здесь важен смысл каждого ярлыка.
Документы, с которых часто начинают
- Техническое задание — исходные требования к программе; подробно — ГОСТ 19.201.
- Спецификация — состав программы и документации на неё.
- Ведомость держателей подлинников — кто хранит подлинники документов.
- Ведомость документов — список документов, входящих в комплект.
Документы о самой программе
- Текст программы — запись кода с нужными комментариями.
- Описание программы — логика, структура, функционирование.
- Описание применения — сведения для использования программы (когда отделяют от руководства).
- Описание языка — если нужен документ о языке/средствах (реже в обычной курсовой).
Документы для людей на эксплуатации
- Руководство системного программиста — проверка, настройка, сопровождение на уровне системы.
- Руководство программиста — использование программы при разработке/модификации.
- Руководство оператора — как работать с программой «на кнопках» в штатном режиме.
Испытания и учёт
- Программа и методика испытаний — как проверять.
- Ведомость эксплуатационных документов — какие эксплуатационные бумаги входят в поставку.
- Формуляр — основные характеристики, комплектность и сведения об эксплуатации конкретного изделия.
- Другие ведомости — например, оборудования, на котором испытывают или с которым поставляют.