Структура и краткое содержание основных стандартов единой системы программной документации еспд

Обновлено: 02.07.2024

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

Во-вторых, грамотно составленный (точнее, созданный) пакет ПД избавит от многих неприятностей. В частности, избавиться от назойливых вопросов и необоснованных претензий можно просто предоставив пользователю документацию. Это касается, прежде всего, важнейшего документа – Технического задания. Например, многомиллионный иск к компании IBM. Этот иск предъявило одно крупное издательство, неудовлетворенное качеством ВТ и программного обеспечения. IBM суд выиграла. И выиграла только благодаря тому, что предъявила подписанное обеими сторонами Техническое задание. Было это давно, еще в 70-х гг., однако сути дела это не меняет.

И еще одно. Важно создать первый пакет ПД. Этого будет достаточно, чтобы на его основе строить все последующие, используя его как образец или шаблон. Но сделать это надо очень качественно. Не спеша. Очень основательно.

Единая система программной документации - комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации.

Стандарты ЕСПД определяют общие положения и основополагающие стандарты, правила выполнения документации разработки, правила выполнения документации изготовления, правила выполнения документации сопровождения, правила выполнения эксплуатационной документации, правила обращения программной документации и прочие стандарты. [29]

Итак, ЕСПД – это комплекс государственных стандартов устанавливающих взаимосвязанные правила разработки и обращения программ и программной документации.

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

В состав ЕСПД входят:

- основополагающие и организационно методические стандарты;

- стандарты, определяющие форму и содержание программных документов применяемых для обработки данных;

- стандарты, обеспечивающие автоматизацию разработки программных документов.

Стандарты ЕСПД упорядочивают процесс документирования программных систем. Основная часть комплекса ЕСПД была разработана в 70-е и 80-е годы. Частично эти стандартны морально устарели, к тому же они не лишены некоторых недостатков. Во-первых, в них не отражены некоторые современные тенденции оформления программ и программной документации, во-вторых, в этих стандартах наличествует многократное дублирование фрагментов программной документации. Тем не менее, за неимением лучшего ориентироваться приходится именно на них.

Стандарты ЕСПД носят рекомендательный характер.

Стандарты ЕСПД разделяются на группы:

- 0 код - группы об общем положении;

- 1 код - группы основополагающей стандартов;

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

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

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

- 5 код - правила выполнения эксплуатационных документов;

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

- 7-8 резервные группы;

- 9 прочие стандарты.

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

В обозначении стандартов ЕСПД должны входить:

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

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

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

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

Рисунок 27 – Схемы алгоритмов программ данных и систем

Вообще перечень документов ЕСПД очень обширен. В него, в частности, входят следующие ГОСТы:

1. ГОСТ 19.001-77 ЕСПД. Общие положения.

2. ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов (переиздан в ноябре 1987г с изм.).

3. ГОСТ 19.102-77 ЕСПД. Стадии разработки.

4. ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.

5. ГОСТ 19.104-78 ЕСПД. Основные надписи.

6. ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.

7. ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.

8. ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.

9. ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.

10. ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний.

11. ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.

12. ГОСТ 19.402-78 ЕСПД. Описание программы.

13. ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.

14. ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.

15. ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.

16. ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.

17. ГОСТ 19.504-79 ЕСПД. Руководство программиста.

18. ГОСТ 19.505-79 ЕСПД. Руководство оператора.

19. ГОСТ 19.506-79 ЕСПД. Описание языка.

21. ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.

22. ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.

23. ГОСТ 19.781-90. Обеспечение систем обработки информации программное.

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

Программу допускается идентифицировать и применять самостоятельно или в составе других программ. Программы подразделяются на:

- компонент – программа рассматриваемая, как единое целое, выполняющее законченную функцию и применяемое самостоятельно или в составе комплекса

- комплекс – программа, состоящая из двух или нескольких компонентов или комплексов, выполняющих взаимосвязанные функции и применяемое самостоятельно или в составе другого комплекса.

Документация, разработанная на программу, может использоваться для реализации и передачи программ на носителях данных, а так же для изготовления. К ПИ относятся документы, содержащие сведения необходимые для разработки изготовления, сопровождения и эксплуатации программ.

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

Существуют следующие виды программных документов:

1. Спецификация – содержит состав, программу и документацию на нее.

2. Ведомость держателей подлинников - это перечень предприятий, на которых хранят подлинники программных документов (код 05).

3. Текст программы – это запись программы с необходимыми комментариями (код 12).

4. Описание программ – содержит сведения с логической структурой и функционированием программы (код 13).

5. Программа и методика испытаний содержит требования подлежащие проверке при испытании программы, а так же порядок и методы их контроля (код 51).

6. Техническое задание указывает назначение и область применения программы, содержит технические, технико-экономические и специальные требования, предъявляемые программе. Необходимые стадии и сроки разработки, и виды испытаний

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

Эксплуатационные документы содержат сведения для обеспечения функционирования и эксплуатации программы. К эксплуатационным документам относятся:

а) ведомость эксплуатационных документов, содержащая перечень эксплуатационных документов на программу (код 20);

б) формуляр, содержащий основные характеристики программ, комплектность и сведения об эксплуатации программ (код30);

в) описание применения, содержащее сведения о назначении программы, области применения, применяемых методов, класс решаемых задач ограничения для применения минимальной конфигурации технических средств (код 31);

г) руководство системного программиста, содержащее сведения проверки обеспечения функционирования и постройки программ на условиях конкретного применения (код 32);

д) руководство программиста, содержащее сведения для эксплуатации программ (код 32);

е) руководство операторов, содержащее сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы (код 34);

ж) описание языка, содержащее описание синтаксиса и семантики языка (код 35);

з) руководство по техническому обслуживанию, содержащее сведения для применения тестовых и диагностических программ при обслуживании технических средств (код 46).

Не все документы обязательны, необходимость составления документов определяется на этапе разработки и утверждении технического задания.

Стадии разработки программ

Существуют следующие стадии разработки программ:

1. Техническое задание – на этапе обоснования необходимости разработки программы формируют постановку задачи, проводят сбор исходных материалов, выбор и обоснование критериев эффективности и качества разрабатываемой программы, дают обоснование необходимости проведения научно-исследовательских работ, на этом этапе определяют структуру входных и выходных данных, проводят предварительный выбор методов решения задач, обосновывают целесообразность применения ранее разработанных программ, определяют требования технических средств, обосновывают принципиальную возможность решения задач. На этом этапе разработки и утверждения технических заданий, определяют требования к программе, разрабатывает технико-экономическое задание разработки программы, определяющее стадии этапов и сроков программы и документации для нее выбирают язык программирования, определяют необходимость проведения научно-исследовательских работ на последующих стадиях, согласовывают и утверждают технических заданий.

2. Эскизный проект. На этапе проводят предварительную разработку структур вход и выход данных, уточняют методы решения задачи, разрабатывают общее описание алгоритма решения задачи и технико-экономическое обоснование. На этом этапе утверждения разрабатывают пояснительную записку, согласовывают и утверждают эскизный проект.

3. Технический проект. На этом этапе разработки уточняют структуру входных и выходных данных, разрабатывают алгоритм решения задачи, определяют форму представления входных и выходных данных, определяют семантику и синтаксис языка, разрабатывают структуру программы, окончательно определяют конфигурацию технических средств. На этом этапе утверждения разрабатывают план мероприятий по разработке и внедрению программ. Разрабатывают пояснительную записку, согласовывают и утверждают технический проект.

4. Рабочий проект. На этом этапе разработки осуществляется программирование и отладка программы. На этапе разработки программной документации разрабатывают программные документы в соответствии с требованиями ГОСТа. На этапе испытания программы проводят разработку, согласование и утверждение программы и методики испытаний, на этапе испытания проводят предварительные государственные, межведомственные, приемосдаточные и другие виды испытаний. Корректируют программу и программную документацию по результатам испытаний.

5. Внедрение. На этапе подготовки передачи программ осуществляют подготовку передачи программы и программной документации для сопровождения и изготовления, оформляют и утверждают акт о передаче программы на сопровождение и изготовление, передают программу в фонд алгоритмов и программ. [29]

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

Unified system for program documentation. General principles

Дата введения 1980-01-01

Постановлением Государственного комитета стандартов Совета Министров СССР от 20 мая 1977 г. N 1268 дата введения установлена 01.01.80

ПЕРЕИЗДАНИЕ. Январь 2010 г.

Настоящий стандарт устанавливает целевое назначение, область распространения, классификацию и правила обозначения стандартов, входящих в комплекс Единой системы программной документации (ЕСПД).

1. НАЗНАЧЕНИЕ ЕСПД

1.1. Единая система программной документации - комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации.

1.2. В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность:

унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;

снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;

автоматизации изготовления и хранения программной документации.

Сопровождение программы включает анализ функционирования, развитие и совершенствование программы, а также внесение изменений в нее с целью устранения ошибок.

2. ОБЛАСТЬ РАСПРОСТРАНЕНИЯ И СОСТАВ ЕСПД

2.1. Правила и положения, установленные в стандартах ЕСПД, распространяются на программы и программную документацию для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

2.2. В состав ЕСПД входят:

основополагающие и организационно-методические стандарты;

стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;

стандарты, обеспечивающие автоматизацию разработки программных документов.

2.3. Разработка организационно-методической документации, определяющей и регламентирующей деятельность организаций по разработке, сопровождению и эксплуатации программ, должна проводиться на основе стандартов ЕСПД.

Единая система программной документации (ЕСПД) — комплекс государственных стандартов, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации.

В стандартах ЕСПД устанавливают требования, регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность:

унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;
снижения трудоемкости и повышения эффективности разработки, сопровождения, изготовления и эксплуатации программных изделий;
автоматизации изготовления и хранения программной документации.

Перечень стандартов, входящих в ЕСПД

Ссылки

Wikimedia Foundation . 2010 .

Полезное

Смотреть что такое "ЕСПД" в других словарях:

ЕСПД — Единая система программной документации Словарь: С. Фадеев. Словарь сокращений современного русского языка. С. Пб.: Политехника, 1997. 527 с. ЕСПД единая сеть передачи данных ЕСПД единый социальный проездной документ Источник:… … Словарь сокращений и аббревиатур

ЕСПД — Единая система программной документации … Словарь сокращений русского языка

Единая система программной документации — (ЕСПД) комплекс государственных стандартов Российской Федерации, устанавливающих взаимосвязанные правила разработки, оформления и обращения программ и программной документации. В стандартах ЕСПД устанавливают требования, регламентирующие… … Википедия

35.080 — Програмне забезпечення ГОСТ 7.70 96 Система стандартов по информации, библиотечному и издательскому делу. Описание баз данных и машиночитаемых информационных массивов. Состав и обозначение характеристик ГОСТ 19.001 77 ЕСПД. Общие положения ГОСТ… … Покажчик національних стандартів

19.001 — ГОСТ 19.001 < 77>ЕСПД. Общие положения. ОКС: 35.080 КГС: Т55 Система административно управленческой документации, документооборота, организация архивного дела Действие: C 01.01.80 Примечание: переиздание 2005 в сб. Единая система программной… … Справочник ГОСТов

19.005 — ГОСТ 19.005 < 85>ЕСПД. Р схемы алгоритмов и программ. Обозначения условные графические и правила выполнения. ОКС: 35.080 КГС: Т55 Система административно управленческой документации, документооборота, организация архивного дела Действие: C… … Справочник ГОСТов

19.101 — ГОСТ 19.101 < 77>ЕСПД. Виды программ и программных документов. ОКС: 35.080 КГС: Т55 Система административно управленческой документации, документооборота, организация архивного дела Действие: C 01.01.80 Изменен: ИУС 9/81 Примечание: переиздание… … Справочник ГОСТов

19.102 — ГОСТ 19.102 < 77>ЕСПД. Стадии разработки. ОКС: 35.080 КГС: Т55 Система административно управленческой документации, документооборота, организация архивного дела Действие: C 01.01.80 Примечание: переиздание 2005 в сб. Единая система программной… … Справочник ГОСТов

19.103 — ГОСТ 19.103 < 77>ЕСПД. Обозначение программ и программных документов. ОКС: 35.080 КГС: Т55 Система административно управленческой документации, документооборота, организация архивного дела Действие: C 01.01.80 Примечание: переиздание 2005 в сб.… … Справочник ГОСТов

19.104 — ГОСТ 19.104 < 78>ЕСПД. Основные надписи. ОКС: 35.080 КГС: Т55 Система административно управленческой документации, документооборота, организация архивного дела Действие: C 01.01.80 Изменен: ИУС 11/81 Примечание: переиздание 2005 в сб. Единая… … Справочник ГОСТов

Свидетельство и скидка на обучение каждому участнику

Зарегистрироваться 15–17 марта 2022 г.

Описание презентации по отдельным слайдам:

Канд. пед. наук, доцент И.В.Гаврилова
2014

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

определяют основные термины, относящиеся к программным продуктам и документам.
ГОСТ 19.004-80. Единая система программной документации. Термины и определения
ГОСТ 19.101-77. Единая система программной документации. Виды программ и программных документов

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

ГОСТ 19781-90
Не ЕСПД
ПО
Составная часть АС и АПК
Должно входить в спецификацию комплекса, раздел:
Комплексы, если ПО удовлетворяет определению комплекса;
Прочие изделия, если ПО- самостоятельный и единственный компонент
Комплекты, если ПО – совокупность программных компонентов, имеющих общее эксплуатационное назначение вспомогательного характера, но не выполняющих взаимосвязанные функции
4

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

6
Виды эксплуатационных документов (19.101)

ПД и стадии
7
Условные обозначения:
- документ обязательный;
- документ обязательный для компонентов, имеющих самостоятельное применение;
- необходимость составления документа определяется на этапе разработки и утверждения технического задания;
- - документ не составляют.

Правила обозначения ПД по ГОСТ 19.103-77
Другие ПД
8

Стадии разработки по ГОСТ 19.102-77
9

Стадии разработки по ГОСТ 19.102-77
10

Стадии разработки по ГОСТ 19.102-77
11

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

применительно к АС в является аналогом руководства по эксплуатации аппаратного изделия, то есть содержит сведения, необходимые для правильной работы АС и его ПО:
состав и содержание дистрибутивного носителя данных;
порядок загрузки данных и программ;
описание всех выполняемых функций, задач, процедур и т. п.
13

Рекомендации
При проектировании АПК и АС удобно вести параллельную разработку аппаратной и программной частей по правилам ЕСКД и КСАС с учетом специфики, накладываемой требованиями ЕСПД.
Целесообразно для ПО АПК не разрабатывать ни руководство оператора, ни руководство пользователя, а порядок работы с ПО излагать в руководстве по эксплуатации комплекса, используя рекомендации по построению руководства пользователя АС.

Текст программы (19.401-78)
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотация и содержание) является необязательным. Для текста программы на исходном языке при наличии аннотации в нее включают краткое описание функций программы.
Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Допускается вводить наименования также и для совокупности разделов.
Каждый из разделов реализуется одним из типов символической записи, например:
символическая запись на исходном языке;
символическая запись на промежуточных языках;
символическое представление машинных кодов и т.п.
В символическую запись разделов рекомендуется включать комментарии, которые могут отражать, например, функциональное назначение, структуру.
20

Описание программы (19.402-78)
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.
Составление информационной части (аннотации и содержания) является обязательным.
Описание программы должно содержать следующие разделы:
общие сведения;
функциональное назначение;
описание логической структуры;
используемые технические средства;
вызов и загрузка;
входные данные;
выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.
Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками.
В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания.

Руководство системного программиста Содержание разделов
28

Читайте также: