Оформление программы по госту (how to). Оформление по еспд программной документации, еспд Гост разработка программного обеспечения документация
Наименование:
Единая система программной документации.
Действует
Дата введения:
Дата отмены:
Заменен на:
Текст ГОСТ 19.101-77 Единая система программной документации. Виды программ и программных документов
ГОСТ 19.101-77
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
ЕДИНАЯ СИСТЕМА ПРОГРАММНОЙ ДОКУМЕНТАЦИИ
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ
Издание официальное
Стандартинформ
УДК 002:651.7/.78:006.354
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ
Unified system for program documentation.
Types of programs and program documents
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. № 1268 дата введения установлена
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
(Измененная редакция, Изм. № 1).
1. ВИДЫ ПРОГРАММ
1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл. 1.
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2, 1.3. (Измененная редакция, Изм. № 1).
2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл. 2.
Издание официальное ★
Перепечатка воспрещена
) Издательство стандартов, 1977 © СТАНДАРТИНФОРМ, 2010
Издание (январь 2010 г.) с Изменением № 1, утвержденным в июне 1981 г. (ИУС 9-81).
Таблица 2
|
Вид программного документа | |
|
Спецификация |
Состав программы и документации на нее |
|
Ведомость держателей подлин- |
Перечень предприятий, на которых хранят подлинники программ- |
|
ных документов |
|
|
Текст программы |
Запись программы с необходимыми коментариями |
|
Описание программы |
Сведения о логической структуре и функционировании программы |
|
Программа и методика испыта- |
Требования, подлежащие проверке при испытании программы, а также |
|
порядок и методы их контроля |
|
|
Техническое задание |
Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
|
Пояснительная записка |
Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
|
Эксплуатационные документы |
Сведения для обеспечения функционирования и эксплуатации программы |
2.3. Виды эксплуатационных документов и их содержание приведены в табл. 3.
Таблица 3
эксплуатационного документа
Ведомость эксплуатационных документов Формуляр
Описание применения
Руководство программиста Руководство оператора
Описание языка Руководство по техническому обслуживанию
Перечень эксплуатационных документов на программу
Основные характеристики программы, комплектность и сведения об эксплуатации программы
Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения
Сведения для эксплуатации программы
Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы
Описание синтаксиса и семантики языка
Сведения для применения тестовых и диагностических программ при обслуживании технических средств
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл. 4.
Таблица 4
|
Код вида документа |
Вид документа |
Стадии разработки |
|||
|
Эскизный |
Технический |
Рабочий проект |
|||
|
компонент |
комплекс |
||||
|
Спецификация | |||||
|
Ведомость держателей подлин- | |||||
|
Текст программы | |||||
|
Описание программы | |||||
|
Ведомость эксплуатационных | |||||
|
документов | |||||
|
Формуляр | |||||
Продолжение таблицы 4
|
Код вида документа |
Стадии разработки | ||||
|
Вид документа |
Эскизный |
Технический |
Рабочий проект |
||
|
компонент |
комплекс |
||||
|
Описание применения | |||||
|
Руководство системного программиста | |||||
|
Руководство программиста | |||||
|
Руководство оператора | |||||
|
Описание языка | |||||
|
Руководство по техническому обслуживанию | |||||
|
Программа и методика испытаний | |||||
|
Пояснительная записка | |||||
|
Прочие документы | |||||
Условные обозначения:
Документ обязательный;
С - документ обязательный для компонентов, имеющих самостоятельное применение;
О - необходимость составления документа определяется на этапе разработки и утверждения технического задания;
Документ не составляют.
2.2-2.5. (Измененная редакция, Изм. № 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии «Рабочий проект».
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. № 1).
- ГОСТ 19.001-77 Единая система программной документации. Общие положения
- ГОСТ 19.005-85 Единая система программной документации. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения
- ГОСТ 19.101-77 Единая система программной документации. Виды программ и программных документов
- ГОСТ 19.102-77 Единая система программной документации. Стадии разработки
- ГОСТ 19.103-77 Единая система программной документации. Обозначения программ и программных документов
- ГОСТ 19.104-78 Единая система программной документации. Основные надписи
- ГОСТ 19.105-78 Единая система программной документации. Общие требования к программным документам
- ГОСТ 19.106-78 Единая система программной документации. Требования к программным документам, выполненным печатным способом
- ГОСТ 19.201-78 Единая система программной документации. Техническое задание. Требования к содержанию и оформлению
- ГОСТ 19.202-78 Единая система программной документации. Спецификация. Требования к содержанию и оформлению
- ГОСТ 19.301-79 Единая система программной документации. Программа и методика испытаний. Требования к содержанию и оформлению
- ГОСТ 19.401-78 Единая система программной документации. Текст программы. Требования к содержанию и оформлению
- ГОСТ 19.402-78 Единая система программной документации. Описание программы
- ГОСТ 19.403-79 Единая система программной документации. Ведомость держателей подлинников
- ГОСТ 19.404-79 Единая система программной документации. Пояснительная записка. Требования к содержанию и оформлению
- ГОСТ 19.501-78 Единая система программной документации. Формуляр. Требования к содержанию и оформлению
- ГОСТ 19.502-78 Единая система программной документации. Описание применения. Требования к содержанию и оформлению
- ГОСТ 19.503-79 Единая система программной документации. Руководство системного программиста. Требования к содержанию и оформлению
- ГОСТ 19.504-79 Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению
- ГОСТ 19.505-79 Единая система программной документации. Руководство оператора. Требования к содержанию и оформлению
- ГОСТ 19.506-79 Единая система программной документации. Описание языка. Требования к содержанию и оформлению
- ГОСТ 19.507-79 Единая система программной документации. Ведомость эксплуатационных документов
- ГОСТ 19.508-79 Единая система программной документации. Руководство по техническому обслуживанию. Требования к содержанию и оформлению
- ГОСТ 19.601-78 Единая система программной документации. Общие правила дублирования, учета и хранения
- ГОСТ 19.602-78 Единая система программной документации. Правила дублирования, учета и хранения программных документов, выполненных печатным способом
- ГОСТ 19.603-78 Единая система программной документации. Общие правила внесения изменений
- ГОСТ 19.604-78 Единая система программной документации. Правила внесения изменений в программные документы, выполненные печатным способом
- ГОСТ 28195-89 Оценка качества программных средств. Общие положения
- ГОСТ 34.601-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированные системы. Стадии создания
- ГОСТ 34.602-89 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы
- ГОСТ Р 56447-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для обработки и интерпретации данных сейсморазведки. Основные функциональные и технические требования
- ГОСТ Р 56448-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для геологического моделирования месторождений. Основные функциональные и технические требования
- ГОСТ Р 56450-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для гидродинамического моделирования систем сбора и подготовки углеводородов. Основные функциональные и технические требования
- ГОСТ Р 55711-2013 Комплекс технических средств автоматизированной адаптивной ВЧ (КВ) дуплексной радиосвязи. Алгоритмы работы
- ГОСТ Р 56566-2015 Информационные технологии. Оценка процессов. Часть 9. Профили целевого процесса
- ГОСТ Р 55692-2013 Модули электронные. Методы составления и отладки тест-программ для автоматизированного контроля
- ГОСТ Р 56449-2015 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для гидродинамического моделирования месторождений. Основные функциональные и технические требования
- ГОСТ Р 56413-2015 Информационные технологии. Европейские профили профессий ИКТ-сектора
- ГОСТ Р ИСО/МЭК 15026-1-2016 Системная и программная инженерия. Гарантирование систем и программного обеспечения. Часть 1. Понятия и словарь
- ГОСТ Р ИСО/МЭК 15026-4-2016 Системная и программная инженерия. Гарантирование систем и программного обеспечения. Часть 4. Гарантии жизненного цикла
- ГОСТ Р 56920-2016 Системная и программная инженерия. Тестирование программного обеспечения. Часть 1. Понятия и определения
- ГОСТ Р 56921-2016 Системная и программная инженерия. Тестирование программного обеспечения. Часть 2. Процессы тестирования
- ГОСТ Р ИСО/МЭК 26555-2016 Системная и программная инженерия. Инструменты и методы технического менеджмента линейки продуктов
- ГОСТ Р ИСО/МЭК 29155-1-2016 Системная и программная инженерия. Структура сопоставительного анализа эффективности выполнения проектов информационных технологий. Часть 1. Понятия и определения
- ГОСТ Р 54360-2011 Лабораторные информационные менеджмент-системы (ЛИМС). Стандартное руководство по валидации ЛИМС
- ГОСТ Р 54593-2011 Информационные технологии. Свободное программное обеспечение. Общие положения
- ГОСТ Р ИСО/МЭК 12207-2010 Информационная технология. Системная и программная инженерия. Процессы жизненного цикла программных средств
- ГОСТ Р 53798-2010 Стандартное руководство по лабораторным информационным менеджмент-системам (ЛИМС)
- ГОСТ Р ИСО/МЭК 15504-1-2009 Информационные технологии. Оценка процессов. Часть 1. Концепция и словарь
- ГОСТ Р ИСО/МЭК 15504-2-2009 Информационная технология. Оценка процесса. Часть 2. Проведение оценки
- ГОСТ Р ИСО/МЭК 15504-3-2009 Информационная технология. Оценка процесса. Часть 3. Руководство по проведению оценки
- ГОСТ Р 57098-2016 Системная и программная инженерия. Управление жизненным циклом. Руководство для описания процесса
- ГОСТ Р 57100-2016 Системная и программная инженерия. Описание архитектуры
- ГОСТ Р 57101-2016 Системная и программная инженерия. Процессы жизненного цикла. Управление проектом
- ГОСТ Р 57102-2016 Информационные технологии. Системная и программная инженерия. Управление жизненным циклом. Часть 2. Руководство по применению ИСО/МЭК 15288
- ГОСТ Р 57122-2016 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Программное обеспечение для проектирования строительства скважин. Основные функциональные и технические требования
- ГОСТ Р 57193-2016 Системная и программная инженерия. Процессы жизненного цикла систем
- ГОСТ Р ИСО/МЭК 15504-5-2016 Информационные технологии. Оценка процессов. Часть 5. Образец модели оценки процессов жизненного цикла программного обеспечения
- ГОСТ 34009-2016 Средства и системы управления железнодорожным тяговым подвижным составом. Требования к программному обеспечению
- ГОСТ Р 57318-2016 Системы промышленной автоматизации и интеграция. Применение и управление процессами системной инженерии
- ГОСТ Р ИСО/МЭК 25001-2017 Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Планирование и управление
- ГОСТ Р ИСО/МЭК 33004-2017 Информационные технологии. Оценка процесса. Требования к эталонным моделям процесса, моделям оценки процесса и моделям зрелости
- ГОСТ Р ИСО/МЭК 15414-2017 Информационные технологии. Открытая распределенная обработка. Эталонная модель. Язык описания предприятия
- ГОСТ IEC 60848-2016 Язык спецификаций GRAFCET для последовательных функциональных схем
- ГОСТ Р ИСО/МЭК 25051-2017 Информационные технологии. Системная и программная инженерия. Требования и оценка качества систем и программного обеспечения (SQuaRE). Требования к качеству готового к использованию программного продукта (RUSP) и инструкции по тестированию
- ГОСТ Р ИСО/МЭК 33001-2017 Информационные технологии. Оценка процесса. Понятия и терминология
- ГОСТ Р ИСО/МЭК 33002-2017 Информационные технологии. Оценка процесса. Требования к проведению оценки процесса
- ГОСТ Р ИСО/МЭК 33003-2017 Информационные технологии. Оценка процесса. Требования к системам измерения процесса
- ГОСТ Р ИСО/МЭК 33020-2017 Информационные технологии. Оценка процесса. Система измерения процесса для оценки возможностей процесса
- ГОСТ Р 57640-2017 Информационные технологии. Эталонная модель процесса (ЭМП) для управления информационной безопасностью
- ГОСТ Р ИСО/МЭК 30121-2017 Информационные технологии. Концепция управления рисками, связанными с проведением судебной экспертизы свидетельств, представленных в цифровой форме
- ГОСТ Р 58041-2017 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Система стандартов по программному обеспечению для решения задач поиска, разведки и разработки месторождений. Основные положения и технические требования
- ГОСТ Р 58042-2017 Месторождения газовые, газоконденсатные, нефтегазовые и нефтегазоконденсатные. Основные требования к исходным данным программных комплексов для решения задач поиска, разведки и разработки месторождений
- ГОСТ Р ИСО/МЭК 10746-1-2004 Информационная технология. Открытая распределенная обработка. Базовая модель. Часть 1. Основные положения
- ГОСТ Р ИСО/МЭК 10746-4-2004 Информационная технология. Открытая распределенная обработка. Базовая модель. Часть 4. Архитектурная семантика
- ГОСТ Р ИСО/МЭК 12119-2000 Информационная технология. Пакеты программ. Требования к качеству и тестирование
- ГОСТ Р ИСО/МЭК 12207-99 Информационная технология. Процессы жизненного цикла программных средств
- ГОСТ Р ИСО/МЭК 14764-2002 Информационная технология. Сопровождение программных средств
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
|
Единая система программной документации |
ГОСТ 19.101-77 (СТ СЭВ 1626-79) |
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ |
|
United system for program documentation. Types of programs and program documents |
Дата введения с 01.01.80
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
1. ВИДЫ ПРОГРАММ
1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл. 1
Таблица 1
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2,1.3.
2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл. 2.
Таблица 2
| Вид программного документа | Содержание программного документа |
|---|---|
| Спецификация | Состав программы и документации на нее |
| Перечень предприятий, на которых хранят подлинники программных документов | |
| Текст программы | Запись программы с необходимыми комментариями |
| Описание программы | Сведения о логической структуре и функционировании программы |
| Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля | |
| Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
| Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
| Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
(Измененная редакция, Изм. № 1).
2.3. Виды эксплуатационных документов и их содержание приведены табл.3.
Таблица 3
| Вид эксплуатационного документа | Содержание эксплуатационного документа |
|---|---|
| Перечень эксплуатационных документов на программу | |
| Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
| Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
| Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения | |
| Руководство программиста | Сведения для эксплуатации программы |
| Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
| Описание языка | Описание синтаксиса и семантики языка |
| Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
(Измененная редакция, Изм. № 1).
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл click . 4.
Таблица 4
| Код вида документа | Вид документа | Стадии разработки | |||
|---|---|---|---|---|---|
| Эскизный проект | Технический проект | Рабочий проект | |||
| компонент | комплекс | ||||
| - | Спецификация | - | - | ||
| 05 | Ведомость держателей подлинников | - | - | - | |
| 12 | Текст программы | - | - | ||
| 13 | Описание программы | - | - | ||
| 20 | Ведомость эксплуатационных документов | - | - | ||
| 30 | Формуляр | - | - | ||
| 31 | Описание применения | - | - | ||
| 32 | Руководство системного программиста | - | - | ||
| 33 | Руководство программиста | - | - | ||
| 34 | Руководство оператора | - | - | ||
| 35 | Описание языка | - | - | ||
| 46 | Руководство по техническому обслуживанию | - | - | ||
| 51 | Программа и методика испытаний | - | - | ||
| 81 | Пояснительная записка | - | - | ||
| 90-99 | Прочие документы | ||||
Условные обозначения:
- документ обязательный;
- документ обязательный для компонентов, имеющих самостоятельное применение;
- необходимость составления документа определяется на этапе разработки и утверждения технического задания;
- - документ не составляют.
2.2-2.5. (Измененная редакция, Изм. № 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии «Рабочий проект».
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. № 1).
Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июне 1981 г (ИУС 9-81)
Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р
|
Система технической документации на АСУ |
ГОСТ 24.207-80 |
ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ ПО ПРОГРАММНОМУ ОБЕСПЕЧЕНИЮ |
|
| System of technical documentation for computer control systems. Requirements for contents of documents on software |
Постановлением Государственного комитета СССР по стандартам от 14 мая 1980 г. № 2101 срок введения установлен
с 01.01 1981 г.
Настоящий стандарт распространяется на техническую документацию на автоматизированные системы управления (АСУ) всех видов, разрабатываемые для всех уровней управления (кроме общегосударственного), и устанавливает требования к содержанию документов, входящих в соответствии с ГОСТ 24.101-80 в состав документации программного обеспечения в проектах АСУ.
1. ОБЩИЕ ПОЛОЖЕНИЯ
1.1. Документация программного обеспечения предназначена:
- для описания проектных решений по программному обеспечению в документе «Описание программного обеспечения АСУ».
- для установления требований к программе (комплексу программ) в документе «Техническое задание»;
- для описания решений, обеспечивающих сопровождение, изготовление и эксплуатацию программы (комплекса программ) в документах «Пояснительная записка», «Описание применения», «Описание программы», «Спецификация», «Руководство программиста», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний»;
- для проверки работоспособности программы (комплекса программ) в документе «Описание контрольного примера».
1.2. При разработке документов на части АСУ содержание разделов каждого документа ограничивают рамками соответствующей части.
1.3. В зависимости от назначения и специфических особенностей создаваемых АСУ допускается включать в документы дополнительные разделы, требования к содержанию которых не установлены настоящим стандартом. Отсутствие проектных решений по разделу документа фиксируют в соответствующем разделе с необходимыми пояснениями.
1.4. Требования к содержанию документов «Техническое задание», «Пояснительная записка», «Описание применения», «Спецификация», «Руководство оператора», «Текст программы», «Формуляр», «Порядок и методика испытаний» установлены ГОСТ 19.201-78 , ГОСТ 19.404-79 , ГОСТ 19.502-78 , ГОСТ 19.202-78 , ГОСТ 19.505-79 , ГОСТ 19.401-78 , ГОСТ 19.501-78 и ГОСТ 19.301-79 .
(Измененная редакция, Изм. № 1).
2. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
2.1. Описание программного обеспечения АСУ
2.1.1. Документ должен содержать вводную часть и разделы:
- структура программного обеспечения;
- основные функции частей программного обеспечения;
- методы и средства разработки программного обеспечения;
- операционная система;
- средства, расширяющие возможности операционной системы.
2.1.2. Вводная часть должна содержать основные сведения о техническом, информационном и других видах обеспечения АСУ, необходимые для разработки программного обеспечения, или ссылку на соответствующие документы проекта АСУ.
2.1.3. Раздел «Структура программного обеспечения» должен содержать перечень частей программного обеспечения с указанием их взаимосвязей и обоснованием выделения каждой из них.
2.1.4. Раздел «Основные функции частей программного обеспечения» должен содержать подразделы, в которых для каждой части программного обеспечения приводят назначение и описание основных функций
(Измененная редакция, Изм. № 1).
2.1.5. Раздел «Методы и средства разработки программного обеспечения» должен содержать перечень методов программирования и средств разработки программного обеспечения АСУ с указанием частей программного обеспечения, при разработке которых следует использовать соответствующие методы и средства.
2.1.6. Раздел «Операционная система» должен содержать:
- наименование, обозначение и краткую характеристику выбранной операционной системы и ее версии, в рамках которой будут выполнять разрабатываемые программы, с обоснованием выбора и указанием источников, где дано подробное описание выбранной версии;
- наименование руководства, в соответствии с которым должна осуществляться генерация выбранного варианта операционной системы;
- требования к варианту генерации выбранной версии операционной системы.
2.1.7. Раздел «Средства, расширяющие возможности операционной системы» должен содержать подразделы, в которых для каждого используемого средства, расширяющего возможности операционной системы, следует указать:
- наименование, обозначение и краткую характеристику средства с обоснованием необходимости его применения и указанием источника, где дано подробное описание выбранного средства;
- наименование руководства, в соответствии с которым следует настраивать используемое средство на конкретное применение;
- требования к настройке используемого средства.
2.2. Описание программы
2.2.2. Для программы (комплекса программ), получаемой за счет использования ранее разработанных программных средств, документ «Описание программы» следует дополнять разделом «Настройка программных средств».
2.2.3. Раздел «Настройка программных средств» должен содержать:
- наименование, обозначение использованных программных средств, описание процедур, необходимых для их настройки, или ссылки на эксплуатационную документацию этих средств;
- перечень элементов использованных программных средств, необходимых для получения программы (комплекса программ);
- описание настройки на языке, предусмотренном в эксплуатационной документации на используемые программные средства.
2.3. Руководство программиста
2.3.1. Документ по составу разделов и их содержанию должен соответствовать ГОСТ 19.504-79 и, кроме того, включать раздел «Сведения о форме представления программы (комплекса программ)».
2.3.2. Раздел «Сведения о форме представления программы (комплекса программ)» должен содержать сведения о носителе, на котором записана программа, о содержании и системе кодирования информации, записанной на носителе, а также сведения, необходимые для чтения информации с носителя.
2.3.3. Для программы (комплекса программ), допускающей настройку на условия конкретного применения, в документ «Руководство программиста» включают разделы:
- структура программы;
- настройка программы;
- дополнительные возможности;
- сообщения системному программисту.
2.3.4. Разрешается для программы (комплекса программ), допускающей настройку на условия конкретного применения, вместо разделов, перечисленных в п. 2.3.3, разрабатывать отдельный документ «Руководство системного программиста», удовлетворяющий требованиям ГОСТ 19.503-79 .
2.4. Описание контрольного примера
2.4.1. Документ должен содержать разделы:
- назначение;
- исходные данные;
- результаты расчета;
- проверка программы (комплекса программ).
2.4.2. Раздел «Назначение» должен содержать перечень параметров и краткую характеристику функции, из числа реализуемых программой (комплексом программ), проверяемых контрольным примером.
2.4.3. Раздел «Исходные данные» должен содержать описание исходных данных для проверки программы (комплекса программ) с приведением исходных данных. Допускается исходные данные представлять в виде распечатки с АЦПУ.
2.4.4. Раздел «Результаты расчета» должен содержать результаты обработки исходных данных программой (комплексом программ), позволяющие оценить правильность выполнения проверяемых функции и значение проверяемых параметров. Допускается результаты расчета приводить в виде распечатки с АЦПУ.
2.4.5. Раздел «Проверка программы (комплекса программ)» должен содержать:
- описание состава технических средств, необходимых для работы программы (комплекса программ), или ссылку на соответствующие программные документы;
- описание процедур формирования исходных данных для проверки программы (комплекса программ), вызова проверяемой программы (комплекса программ) и получения результатов расчета;
- описание действий оператора при подготовке исходных данных и проверке программы (комплекса программ) на контрольном примере.
Единая система документации программной продукции – ЕСПД – относится к ГОСТ класса 19 и подразделяется на 10 групп:
1. Основополагающие стандарты.
2. Правила выполнения документации разработки.
3. Правила выполнения документации изготовления.
4. Правила выполнения документации сопровождения.
5. Правила выполнения эксплуатационной документации.
6. Правила обращения программной документации.
Стандарт с номером 0 содержит общие положения, стандарты 7 и 8 являются зарезервированными и к номеру 9 относятся прочие стандарты, не вошедшие в первые 6.
Это краткие описания ГОСТов класса 19, для более подробного ознакомления с ними необходимо обратиться к справочникам.
- ГОСТ 19.001-77 – единая система программной документации.
- ГОСТ 19.101-77 – виды программ и программных документов.
- ГОСТ 19.102-77 – стадии разработки программ и программной документации.
- ГОСТ 19.105-78 – требования к оформлению программных документов, комплексов и систем независимо от их назначения и области применения. ГОСТ 19.105-78 содержит полный перечень документации, которая должна сопровождать законченный программный продукт.
Перечень документации, декларируемой ГОСТ 19.105-78:
1. Документы, содержащие сведения, необходимые для разработки программного продукта, его изготовления.
1.1. Спецификация – состав программы и документации на нее.
1.2. Ведомость держателей подлинников – перечень предприятий, на которых хранятся подлинники программной документации.
1.3. Текст программы – запись текста программы с необходимыми комментариями.
1.4. Описание программы – сведения о логической и функциональной структуре программы.
1.5. Программа и методика испытаний – требования, подлежащие проверке при испытании программы, порядок и методы их контроля.
1.6. Техническое задание – назначение и область применения программы, технические и специальные требования, необходимые стадии и сроки разработки, виды испытаний.
2. Документы, используемые при эксплуатации программного продукта.
Ведомость эксплуатационных документов – перечень эксплуатационных документов на программу.
Формуляр – основные характеристики программы, комплектность, общие сведения об эксплуатации программы.
Описание применения – сведения о назначении программы, области применения, классе решаемых задач, ограничения на применение, необходимая конфигурация технических средств.
Руководство системного программиста – сведения для проверки и обеспечения функциональности, настройки программы.
Руководство программиста – сведения для эксплуатации настроенной программы.
Руководство оператора – сведения для обеспечения процедуры общения оператора с ЭВМ в процессе выполнения программы.
Описание языка – описание синтаксиса и семантики языка, используемого в программе.
Руководство по техническому обслуживанию – сведения для применения тестовых программ при обслуживании технических средств.
Другие ГОСТы класса 19:
- ГОСТ 19.201-78 – порядок построения и оформления технического задания на разработку программы или программного изделия.
- ГОСТ 19.202-78 – форма и порядок составления спецификации на программные продукты, определяемые в ГОСТ 19.101-77.
- ГОСТ 19.301-79 – программа и методика испытаний программных продуктов.
- ГОСТ 19.401-78 – порядок построения и оформления текста программы при разработке программных продуктов.
- ГОСТ 19.402-78 – описание программы.
- ГОСТ 19.403-79 – форма заполнения и содержание ведомости держателей подлинников, определяемой в ГОСТ 19.105-78.
- ГОСТ 19.404-79 – форма заполнения и содержание пояснительной записки, определяемой в ГОСТ 19.105-78.
- ГОСТ 19.501-78 – форма заполнения и содержание формуляра на программный продукт, определяемый в ГОСТ 19.105-78.
- ГОСТ 19.502-78 – форма заполнения и содержание описания применения, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.503-79 – форма заполнения и содержание руководства системного программиста, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.504-79 – форма заполнения и содержание руководства программиста, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.505-79 – форма заполнения и содержание руководства оператора, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.506-79 – форма заполнения и содержание описания языка, определяемого в ГОСТ 19.105-78.
- ГОСТ 19.507-79 – форма заполнения и содержание ведомости эксплуатационных документов, определяемой в ГОСТ 19.105-78.
- ГОСТ 19.508-79 – форма заполнения и содержание руководства по техническому обслуживанию, определяемому в ГОСТ 19.105-78.
- ГОСТ 19.701-90 – схемы алгоритмов, программ, данных и систем.