Оформление программы по ГОСТу (how to) — различия между версиями
Dneprov (обсуждение | вклад) |
Dneprov (обсуждение | вклад) (→Вид программного документа. ГОСТ 19.101 - 77) |
||
| Строка 25: | Строка 25: | ||
{| class="wikitable" border="1" | {| class="wikitable" border="1" | ||
|-allign = "center" | |-allign = "center" | ||
| − | |||
!Вид программного документа | !Вид программного документа | ||
!Содержание программного документа | !Содержание программного документа | ||
|- | |- | ||
| − | + | |Спецификация||Состав программы и документации на нее | |
|- | |- | ||
| − | + | |Ведомость держателей подлинников||Перечень предприятий, на которых хранят подлинники программных документов | |
|- | |- | ||
| − | + | |Текст программы||Запись программы с необходимыми комментариями | |
|- | |- | ||
| − | + | |Описание программы||Сведения о логической структуре и функционировании программы | |
|- | |- | ||
| − | + | |Программа и методика испытаний||Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля | |
|- | |- | ||
| − | + | |Техническое задание||Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний | |
|- | |- | ||
| − | + | |Пояснительная записка||Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений | |
|- | |- | ||
| − | + | |Эксплуатационные документы||Сведения для обеспечения функционирования и эксплуатации программы | |
|} | |} | ||
Версия 11:29, 20 сентября 2013
Программы для ЭВМ оформляются в соответствие с требованиями Единой системы программной документации (ЕСПД). ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
Краткий алгоритм оформления программы
Кратко алгоритм оформления программы изображен на рисунке. Более подробно процесс оформления описан далее.
convert: no images defined `/tmp/transform_125fdb971edb-1.png' @ error/convert.c/ConvertImageCommand/3044.
Оформление программного документа
Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77, ГОСТ 19.103-77, ГОСТ 19.104-78, ГОСТ 19.105-78, ГОСТ 19.106-78, ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.
Вид программного документа. ГОСТ 19.101 - 77
ГОСТ 19.101-77 устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения.
ГОСТ устанавливает 2 вида программ:
- Компонент - программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса;
- Комплекс - программа, состоящая из двух или более компонентов и(или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Также ГОСТ определяет виды и содержание программных документов.
| Вид программного документа | Содержание программного документа |
|---|---|
| Спецификация | Состав программы и документации на нее |
| Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
| Текст программы | Запись программы с необходимыми комментариями |
| Описание программы | Сведения о логической структуре и функционировании программы |
| Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
| Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
| Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
| Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
