Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД) . ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.
Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.
Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77 , ГОСТ 19.103-77 , ГОСТ 19.104-78 , ГОСТ 19.105-78 , ГОСТ 19.106-78 , ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.
ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.
Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".
Материалы программного документа должны располагаться в следующей последовательности :
В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.
Форматирование текста:
В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.
1. Общие положения
ООО «ПРОМНОВАЦИЯ» (ОГРН, адрес, прочее), именуемое в дальнейшем «Разработчик», обязуется защищать и соблюдать конфиденциальность данных, предоставляемых пользователями при использовании Сайта разработчика (далее Сайт) и Программного обеспечения, созданного Разработчиком (далее Программа). Данной Политикой устанавливаются правила, в соответствии с которыми осуществляется обработка данных пользователя Сайта или Программы (далее Пользователь), получившего к ним правомерный доступ на законных условиях.
Условием использования Программы является согласие Пользователя с настоящей Политикой, размещенной на сайте Разработчика по адресу: http:// privacypolicy.сайт. При каждом доступе и/или фактическом использовании Программы, пользователь соглашается с условиями настоящей Политики, а также с условиями соглашений, устанавливающих правила использования соответствующей Программы, которые размещены на Сайте, в редакциях, которые действовали на момент фактического использования Сайта или Программы.
2. Использование персональных данных
Принимая условия настоящей Политики, а равно используя Программу или Сайт, Пользователь принимает и соглашается на обработку данных, которые становятся доступны Разработчику в процессе использования Пользователем Программы или Сайта.
Разработчик использует личную информацию Пользователя для обслуживания и для улучшения качества предоставляемых услуг. Часть персональной информации может быть предоставлена банку или платежной системе, в случае, если предоставление этой информации обусловлено процедурой перевода средств платежной системе, услугами которой Пользователь желает воспользоваться. Разработчик прилагает все усилия для сбережения в сохранности личных данных Пользователя. Личная информация может быть раскрыта в случаях, описанных законодательством РФ, либо когда администрация сочтет подобные действия необходимыми для соблюдения юридической процедуры, судебного распоряжения или легального процесса необходимого для работы Пользователя с Сайтом или Программой. В других случаях, ни при каких условиях, информация, которую Пользователь передает Разработчику, не будет раскрыта третьим лицам.
Обработка данных Пользователя осуществляется в срок с момента начала использования Программы или Сайта и до момента прекращения их использования, если иное не обусловлено функционалом Программы или Сайта и/или не предусмотрено применимым законодательством.
3. Действие настоящей Политики
Разработчик оставляет за собой право вносить изменения и дополнения в настоящую Политику. Новая редакция Политики вступает в силу с момента ее размещения на Сайте. Пользователь обязуется самостоятельно регулярно знакомиться с новыми редакциями Политики.
На Сайте Разработчика могут содержаться ссылки на другие сайты. Сайт не несет ответственности за содержание, качество и политику безопасности этих сайтов. Данное заявление о конфиденциальности относится только к информации, размещенной непосредственно на Сайте Разработчика или в Программе.
Единая система документации программной продукции – ЕСПД – относится к ГОСТ класса 19 и подразделяется на 10 групп:
1. Основополагающие стандарты.
2. Правила выполнения документации разработки.
3. Правила выполнения документации изготовления.
4. Правила выполнения документации сопровождения.
5. Правила выполнения эксплуатационной документации.
6. Правила обращения программной документации.
Стандарт с номером 0 содержит общие положения, стандарты 7 и 8 являются зарезервированными и к номеру 9 относятся прочие стандарты, не вошедшие в первые 6.
Это краткие описания ГОСТов класса 19, для более подробного ознакомления с ними необходимо обратиться к справочникам.
Перечень документации, декларируемой ГОСТ 19.105-78:
1. Документы, содержащие сведения, необходимые для разработки программного продукта, его изготовления.
1.1. Спецификация – состав программы и документации на нее.
1.2. Ведомость держателей подлинников – перечень предприятий, на которых хранятся подлинники программной документации.
1.3. Текст программы – запись текста программы с необходимыми комментариями.
1.4. Описание программы – сведения о логической и функциональной структуре программы.
1.5. Программа и методика испытаний – требования, подлежащие проверке при испытании программы, порядок и методы их контроля.
1.6. Техническое задание – назначение и область применения программы, технические и специальные требования, необходимые стадии и сроки разработки, виды испытаний.
2. Документы, используемые при эксплуатации программного продукта.
Ведомость эксплуатационных документов – перечень эксплуатационных документов на программу.
Формуляр – основные характеристики программы, комплектность, общие сведения об эксплуатации программы.
Описание применения – сведения о назначении программы, области применения, классе решаемых задач, ограничения на применение, необходимая конфигурация технических средств.
Руководство системного программиста – сведения для проверки и обеспечения функциональности, настройки программы.
Руководство программиста – сведения для эксплуатации настроенной программы.
Руководство оператора – сведения для обеспечения процедуры общения оператора с ЭВМ в процессе выполнения программы.
Описание языка – описание синтаксиса и семантики языка, используемого в программе.
Руководство по техническому обслуживанию – сведения для применения тестовых программ при обслуживании технических средств.
Другие ГОСТы класса 19:
ГОСТ 19.101-77
Группа Т55
МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ
Единая система программной документации
ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ
Unified system for program documentation. Types of programs and program documents
МКС 35.080
Дата введения 1980-01-01
Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. N 1268 дата введения установлена 01.01.80
ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в июне 1981 г. (ИУС 9-81).
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
Стандарт полностью соответствует СТ СЭВ 1626-79.
(Измененная редакция, Изм. N 1).
1. ВИДЫ ПРОГРАММ
1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл.1.
Таблица 1
Вид программы | Определение |
Компонент | Программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса |
Комплекс | Программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса |
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
1.2, 1.3. (Измененная редакция, Изм. N 1).
2.1. К программным относят документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.
2.2. Виды программных документов и их содержание приведены в табл.2.
Таблица 2
Вид программного документа | |
Спецификация | Состав программы и документации на нее |
Перечень предприятий, на которых хранят подлинники программных документов |
|
Текст программы | Запись программы с необходимыми комментариями |
Описание программы | Сведения о логической структуре и функционировании программы |
Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля |
|
Техническое задание | Назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний |
Пояснительная записка | Схема алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений |
Эксплуатационные документы | Сведения для обеспечения функционирования и эксплуатации программы |
2.3. Виды эксплуатационных документов и их содержание приведены в табл.3.
Таблица 3
Вид эксплуатационного документа | |
Перечень эксплуатационных документов на программу |
|
Формуляр | Основные характеристики программы, комплектность и сведения об эксплуатации программы |
Описание применения | Сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств |
Сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения |
|
Руководство программиста | Сведения для эксплуатации программы |
Руководство оператора | Сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы |
Описание языка | Описание синтаксиса и семантики языка |
Сведения для применения тестовых и диагностических программ при обслуживании технических средств |
2.4. В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102-68), предназначенные для разработки, сопровождения и эксплуатации программы.
2.5. Виды программных документов, разрабатываемых на разных стадиях, и их коды приведены в табл.4.
Таблица 4
Код | Вид документа | Стадии разработки |
|||
Эскизный проект | Технический проект | Рабочий проект |
|||
компонент | комплекс |
||||
Спецификация | |||||
Ведомость держателей подлинников | |||||
Текст программы | |||||
Описание программы | |||||
Ведомость эксплуатационных документов | |||||
Формуляр | |||||
Описание применения | |||||
Руководство системного программиста | |||||
Руководство программиста | |||||
Руководство оператора | |||||
Описание языка | |||||
Руководство по техническому обслуживанию | |||||
Программа и методика испытаний | |||||
Пояснительная записка | |||||
Прочие документы |
Условные обозначения:
- документ обязательный;
- документ обязательный для компонентов, имеющих самостоятельное применение;
- необходимость составления документа определяется на этапе разработки и утверждения технического задания;
- - документ не составляют.
2.2-2.5. (Измененная редакция, Изм. N 1).
2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии "Рабочий проект".
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. N 1).
Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной
документации: Сб. ГОСТов. -
М.: Стандартинформ, 2010
Наименование:
Единая система программной документации.
Действует
Дата введения:
Дата отмены:
Заменен на:
ГОСТ 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. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.
1.2. Программы подразделяют на виды, приведенные в табл. 1.
1.3. Документация, разработанная на программу, может использоваться для реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
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.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.
В объединенных документах должны быть приведены сведения, которые необходимо включать в каждый объединяемый документ.
2.7. На этапе разработки и утверждения технического задания определяют необходимость составления технических условий, содержащих требования к изготовлению, контролю и приемке программы.
Технические условия разрабатывают на стадии «Рабочий проект».
2.8. Необходимость составления технического задания на компоненты, не предназначенные для самостоятельного применения, и комплексы, входящие в другие комплексы, определяется по согласованию с заказчиком.
(Введен дополнительно, Изм. № 1).