Единая система программной документации

Единая система программной документации

Для обеспечения сопоставимости и единства интерпретации программной документации в Советском Союзе была разработана Единая Система Программной Документации (ЕСПД). Ниже приводятся выдержки из головного стандарта системы: ГОСТ 19.001-77 «Общие положения», определяющего назначение, состав и область применения ЕСПД.

Назначение и цели ЕСПД

Единая система программной документации - комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации. В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность: 1. унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках; 2. снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;  3. автоматизации изготовления и хранения программной документации.

В понятие «сопровождение программы» включается:  1. анализ функционирования программы,  2. развитие и совершенствование программы, 3.внесение изменений в нее с целью устранения ошибок.

В состав ЕСПД входят: 1. основополагающие и организационно-методические стандарты; 2. стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных; 3. стандарты, обеспечивающие автоматизацию разработки программных документов.

Классификация и обозначение стандартов ЕСПД

Стандарты ЕСПД подразделяют на группы, приведенные в таблице.

Код группы

Наименование группы

0

Общие положения

1

Основополагающие стандарты

2

Правила выполнения документации разработки

3

Правила выполнения документации изготовления

4

Правила выполнения документации сопровождения

5

Правила выполнения эксплуатационной документации

6

Правила обращения программной документации

7

Резервные группы

8

 

9

Прочие стандарты

Обозначения стандартов ЕСПД строят по классификационному признаку. В обозначение стандарта ЕСПД должны входить:

          цифры 19, присвоенные классу стандартов ЕСПД;

          одна цифра (после точки), обозначающая код классификационной группы стандартов, указанной в п. 3.1;

          двузначное число, определяющее порядковый номер стандарта в группе;

          двузначное число (после тире), указывающее год регистрации стандарта.

Пример обозначения стандарта " Единая система программной документации. Общие положения ":

ГОСТ 19.001-77

I                        I  I I  I

|        III  |  Год регистрации стандарта

|    |  | J______ Порядковый номер стандарта в группе

|    |  J______ Классификационная группа стандартов

|    J__________ Класс (стандарты ЕСПД)

|  Категория стандарта (государственный стандарт)

Изменение целей и назначения системы стандартов ЕСПД при переходе к рыночной экономике

При переходе к рыночным методам управления экономикой страны отпала необходимость жесткой регламентации формы и содержания программной документации для обеспечения ее сопоставимости. В социалистической экономике дублирование разработок (например, разработка одной и той же программы несколькими авторами) жестко пресекалась, так как вело к необоснованному перерасходу государственных средств. В рыночной экономике, такое дублирование даже приветствуется. Фирмы ведут разработки на свои средства, а потом выставляют конкурирующую продукцию на рынок. Покупатель сам определяет, какую продукцию ему купить. Конкуренция заставляет разработчиков выпускать все более совершенную и качественную продукцию.

В этих условиях изменяется роль стандартов ЕСПД. Их требования остаются обязательными только при определенных условиях7 или в случае, если соблюдение

7 Например, при регистрации программы как объекта интеллектуальной собственности оформление программной документации должно соответствовать требованиям стандартов 19.104-78 и 19.106-78. требований стандарта упомянуто в договоре. В остальных случаях требования стандарта носят рекомендательный характер.

Перечень стандартов, входящих в Единую Систему Программной Документации

ГОСТ

Название

19.001-77

Общие положения

19.002-80

Схемы алгоритмов и программ. Правила выполнения

19.003-80

Схемы алгоритмов и программ. Обозначение условные графические

19.004-80

Термины и определения

19.101-77

Виды программ и программных документов

19.102-77

Стадии разработки

19.103-78

Обозначение программ и программных документов

19.104-78

Основные надписи

19.105-78

Общие требования к программным документам

19.201-78

Техническое задание. Требования к содержанию и оформлению

19.202-78

Спецификация. Требования к содержанию и оформлению

19.301-79

Программа и методика испытаний. Требования к содержанию и  оформлению

19.401-78

Текст программы. Требования к содержанию и оформлению

19.402-78

Описание программы

19.404-79

Пояснительная записка. Требования к содержанию и оформлению

19.501-78

Формуляр Требования к содержанию и оформлению

19.504-79

Руководство программиста. Требования к содержанию и оформлению

19.505-79

Руководство оператора. Требования к содержанию и оформлению

19.506-79

Описание языка. Требования к содержанию и оформлению

19.507-79

Ведомость эксплуатационных документов

19.601-78

Общие правила дублирования, учета и хранения

19.603-78

Общие правила внесения изменений

19.604-78

Правила внесения изменений в программные документы, выполненные печатным способом

Виды программной документации

 Вид документа

Комментарий

Спецификация.

Перечень документов

Формуляр

Титульный лист, в котором указываются основные реквизиты программы

Техническое задание.

Система требований к программному комплексу

Пояснительная записка

Пояснение к техническому заданию

Программа и методика испытаний.

Методика, по которой проверяется соответствие программы предъявленным к ней требованиям

Текст программы.

Исходный код

Сопроводительная документация

Передается Заказчику или покупателю вместе с программой. Перечисленные ниже документы входят в сопроводительную документацию. Допускается объединять их в один документ.

Руководство пользователя

 

Описание программы

 

Описание применения

 

Руководство системного программиста

 

Руководство программиста.

 

Руководство оператора.