Оформление программы по ГОСТу (how to) — различия между версиями
Dneprov (обсуждение | вклад) |
Dneprov (обсуждение | вклад) |
||
| Строка 1: | Строка 1: | ||
| − | Программы для ЭВМ оформляются в | + | Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации [http://ru.wikipedia.org/wiki/Единая_система_программной_документации (ЕСПД)]. ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов. <br /> |
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов. | Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов. | ||
Версия 13:40, 20 сентября 2013
Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД). ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
Содержание |
Краткий алгоритм оформления программы
Кратко алгоритм оформления программы изображен на рисунке. Более подробно процесс оформления описан далее.
convert: no images defined `/tmp/transform_32e47462576d-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.105 - 78
ГОСТ 19.105-78 устанавливает общие требования к оформлению программных документов.
По данному ГОСТу, программный документ должен состоять из следующих частей:
- Титульная часть. Титульная часть состоит из листа утверждения и титульного листа. Правила оформления листа утверждения и титульного листа описаны далее.
- Информационная часть. Информационная часть должна состоять из аннотации и содержания.
- В аннотации приводят сведения о назначении документа и краткое изложение его основной части.
- Содержание включает перечень записей о структурных элеметнах основной части документа.
Необходимость наличия информационной части в разных видах программных документов определяется соответствующими ГОСТами на эти программные документы.
- Основная часть. Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
- Часть регистрации изменений В этой части делается запись о каждом изменеии программного документа в соответствии с требованиями ГОСТ 19.603 - 78.
Вид программного документа. ГОСТ 19.101 - 77
ГОСТ 19.101-77 устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем, независимо от их назначения и области применения.
ГОСТ устанавливает 2 вида программ:
- Компонент - программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса;
- Комплекс - программа, состоящая из двух или более компонентов и(или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Также ГОСТ определяет виды и содержание программных документов.
| Вид программного документа | Содержание программного документа |
|---|---|
| Спецификация | Состав программы и документации на нее |
| Ведомость держателей подлинников | Перечень предприятий, на которых хранят подлинники программных документов |
| Текст программы | Запись программы с необходимыми комментариями |
| Описание программы | Сведения о логической структуре и функционировании программы |
| Программа и методика испытаний | Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
| Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
| Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
| Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
Обозначение программ и программных документов. ГОСТ 19.103 - 77
ГОСТ 19.103-77 устанавливает структуру обозначения программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Проще говоря, данный ГОСТ описывает каким должен быть шифр документа вида А.В.ХХХХХ-ХХ ХХ ХХ-Х, и что означает каждое поле данного шифра.
Основные надписи. ГОСТ 19.104 - 78
ГОСТ 19.104-78 устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах, предусмотренных стандартами ЕСПД, независимо от способа их выполнения.
В ГОСТе есть примеры титульного листа и листа утверждения, а также общая форма листа, разбитая на поля. Также можно посмотреть пример.
