Презентация по МДК 01.02 на тему "ЕСПД"

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

Программная документация
ВНЕШНЯЯ – всевозможные руководства для пользователей, техническое задание, справочники

ВНУТРЕННЯЯ – внутренние стандарты, комментарии исходного текста, технологии программирования
2

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

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

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

Стандарты ЕСПД регламентируют:
разработку;
сопровождение;
изготовление;
эксплуатацию программы.
6

Стандарты ЕСПД, ГОСТ 34, ISO/IEC носят рекомендательный характер…
В соответствии с Законом РФ «О стандартизации» эти стандарты становятся обязательными на контрактной основе, т.е. при ссылке на них в договоре на разработку (поставку) ПС.
7

Состав ЕСПД (группы стандартов)
0 - Общие положения
1 – Основополагающие стандарты
2 – Правила выполнения документации разработки
3 – Правила выполнения документации выполнения
4 – Правила выполнения документации сопровождения
5 – Правила выполнения эксплуатационной документации
6 – Правила обращения программной документации
7 – Резервная группа
8 – Резервная группа

8

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

ГОСТ 19.001-77 ЕСПД. Общие положения
ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов. (переиздан в 1987)
ГОСТ 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 ЕСПД. Описание программы

10

ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению
ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению
ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению
ГОСТ 19.504-79 ЕСПД. Руководство программиста
ГОСТ 19.505-79 ЕСПД. Руководство оператора
ГОСТ 19.506-79 ЕСПД. Описание языка
ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению
ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом
ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем
ГОСТ 19.781-90 ЕСПД. Обеспечение систем обработки информации программное.


11

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

Постановка задачи Тестирование
Техническое задание
Пояснительная записка
Программа и методика испытаний
Требования
Реализация задачи
Описание программы
Текст
программы
Руководство пользователя
Пояснения
Программная документация
13

Регистрация программы

Текст программы
Реферат
Сертификация программы

Сведения о регистрации
Формуляр
Руководство пользователя
Использование программы

-Лицензия
-Руководство пользователя
-Программа и методика испытаний
14

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

ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов
Настоящий стандарт устанавливает виды программ и программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
16

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

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

ГОСТ 2.102-2013 ЕСКД. Виды и комплектность документов
В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию.
19

ГОСТ 19.102-77
Стадии разработки
Настоящий стандарт устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
20

21

22

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

Код страны-разработчика и код организации-разработчика присваивают в установленном порядке
Регистрационный номер присваивают в соответствии с Общероссийским классификатором программ, утверждаемым Госстандартом в порядке возрастания, начиная с 00001 до 99999 для каждой организации-разработчика.
Номер издания программы или номер редакции, номер документа данного вида, номер части документа присваиваются в порядке возрастания с 01 до 99. (если документ состоит из одной части, то дефис и порядковый номер части не указывают).
Номер редакции спецификации и ведомости эксплуатационных документов на программу должны совпадать с номером издания этой же программы.
24

«Вариант исполнения» в ЕСПД отсутствует и заменяется «номером редакции»
Документ «текст программы» имеет обозначение 12 (согласно ГОСТ 19.101-77)
Дальше принято обозначать «исходники»
12 01, т.е. 01 (первый) документ вида 12, «бинарники» 12 02 , т.е. 02 (второй) документ вида 12.
25

ГОСТ 19.201-87
ЕСПД. Техническое задание
Устанавливает порядок построения и оформления технического задания на разработку программы или программного изделия для вычислительных машин, комплексов и систем независимо от их назначения и области применения.
26

Техническое задание должно содержать следующие разделы:
наименование и область применения;
основание для разработки;
назначение разработки;
технические требования к программе или программному изделию;
технико-экономические показатели;
стадии и этапы разработки;
порядок контроля и приемки;
приложения.
27

Раздел «Наименование и область применения»
В разделе указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.
28

Раздел «Основание для разработки»
В разделе должны быть указаны:
документ (документы), на основании которых ведется разработка;
организация, утвердившая этот документ и дата его утверждения;
наименование и (или) условное обозначение темы разработки.

В учебном процессе основанием может служить задание на курсовое проектирование
29

Раздел «Назначение разработки»
В разделе должно быть указано функциональное и эксплуатационное назначение программы или программного изделия.

Например: Программа представляет собой ядро автоматизированного рабочего места (АРМ) разработчика непрерывных линейных систем автоматического управления (САУ), позволяющее пользователю решать задачи анализа простых моделей.
30

Раздел «Технические требования к программе или программному изделию»
Раздел должен содержать следующие подразделы:
требования к функциональным характеристикам;
требования к надежности;
условия эксплуатации;
требования к составу и параметрам технических средств;
требования к информационной и программной совместимости;
требования к маркировке и упаковке;
требования к транспортированию и хранению;
специальные требования.

31

Требования к функциональным характеристикам
Должны быть указаны требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам и т.п.
Например: Программа должна позволять ….вычислять…. строить….. создавать…
Исходные данные: текстовый файл с заданной …..
Выходные данные: графическая и текстовая информация – результаты анализа системы…; текстовые файлы – отчеты о…. диагностика состояния системы и сообщения о всех возникших ошибках.
32

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

Условия эксплуатации
Должны быть указаны условия эксплуатации (температура окружающего воздуха, относительная влажность и т.п. для выбранных типов носителей данных), при которых должны обеспечиваться заданные характеристики, а также вид обслуживания, необходимое количество и квалификация персонала.
По квалификации персонала можно ограничиться фразами: «Программа должна быть рассчитана на непрофессионального пользователя»
«Условия эксплуатации программы совпадают с условиями эксплуатации ПЭВМ IBM PC и совместимых с ними ПК»
34

Требования к составу и параметрам технических средств
Указывают необходимый состав технических средств с указанием их технических характеристик.


Например: Необходимо наличие IBM PC – совместимое с графическим адаптером EGA (VGA). Необходимое дисковое пространство – не менее 600 Мб, объем свободной оперативной памяти – не менее 400 Кб. Желательно наличие драйвера EMS и манипулятора типа «мышь».
35

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

Например: Программа должна работать автономно под управлением ОС MS DOS версии не ниже 3.3. Базовый язык программирования – Turbo Pascal 6.0.
36

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

37

Специальные требования
Очень ответственный раздел.
По-возможности их лучше всего избегать.

Например: Специальных требований к временным характеристикам программы не предъявляется. Специальных требований к емкостным характеристикам программы не предъявляется
38

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

Стадии и этапы разработки
Устанавливают необходимые стадии разработки, этапы и содержание работ (перечень программных документов, которые должны быть разработаны, согласованы и утверждены, а также сроки разработки и определение исполнителей).
Основные стадии и этапы:
- техническое задание;
- эскизный проект;
- технический проект;
- рабочий проект.
- внедрение
40

Порядок контроля и приемки
Должны быть указаны виды испытаний и общие требования к приемке работы.
В этом пункте лучше указать, что контроль и приемка разработки осуществляются на предоставляемой заказчиком технике…

Например: Контроль и приемка разработки осуществляются на основе испытаний контрольно-отладочных примеров. При этом проверяется выполнение всех функций программы.
41

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


42

ГОСТ 19.102-77
ЕСПД. Стадии разработки
Устанавливает стадии разработки программ, программной документации, а также этапы и содержание работ.
43

Стадии разработки
Техническое задание.
Эскизный проект.
Технический проект.
Рабочий проект.
Внедрение.
44

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

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

Эскизный проект

Разработка эскизного проекта
Утверждение эскизного проекта
Предварительная разработка структуры входных и выходных данных. Уточнение методов решения задачи. Разработка общего описания алгоритма решения задачи. Разработка технико-экономического обоснования.
Разработка пояснительной записки.
Согласование и утверждение эскизного проекта.
46

Технический проект

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

47

Внедрение

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

Примечание

Допускается исключать вторую стадию разработки, а в технически обоснованных случаях – вторую и третью стадию. Необходимость проведения этих стадий указывается в техническом задании.
Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с Заказчиком.
49

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

Титульная часть состоит из листа утверждения и титульного листа. Правила оформления по ГОСТ 19.104-78)
Информационная часть должна состоять из аннотации и содержания. В аннотации приводят сведения о назначении документа и краткое изложение основной части. Содержание включает перечень записей о структурных элементах основной части документа, в каждую из которых входят обозначение структурного элемента (номер раздела, подраздела и т.п.), наименование структурного элемента, адрес структурного элемента на носителе данных (например номер страницы, номер файла и т.п.)

51

ГОСТ 19.104-78 ЕСПД.
Основные надписи
Стандарт устанавливает формы, размеры, расположение и порядок заполнения основных надписей листа утверждения и титульного листа в программных документах.
ЛУ остается на предприятии, т.к. содержит подписи начальства и разработчиков, нормоконтролеров, представителей приемки. (высылается только по особому указанию)
52

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

Поле 1 – наименование министерства (ведомства)
Поле 2 – не заполняют
Поле 3 – полное наименование программы или программного изделия, наименование и вид документа
Поле 4 – обозначение документа и указание вида носителя данных
Поле 5 – указывают объем документа
Поле 6 – не заполняют (при наличии ЛУ)
Поле 7 – год издания (утверждения) документа (без указания слова «год» или «г»)
Поле 8 – отметка об учете и хранении по ГОСТ 19.601-78
Поле 9 – строка изменений по ГОСТ 19.604-78
Поле 10 – литера документа








54

55

56

ГОСТ 19.402-78 ЕСПД. Описание программы
Стандарт ориентирован на документирование результирующего продукта разработки.
Описание программы должно включать информационную часть:
- аннотацию;
- содержание.


57

Основная часть документа должна состоять из вводной части и следующих разделов:
общие сведения;
функциональное назначение;
описание логической структуры;
используемые технические средства;
вызов и загрузка;
входные данные;
выходные данные.
58

Раздел Общие сведения
В этом разделе должны быть указаны:
- обозначение и наименование программы;
- программное обеспечение, необходимое для функционирования программы;
- языки программирования, на котором написана программа.

Например: Программа «Автоматизированное рабочее место разработчика САУ» предназначена для … реализована на …. Программа поддерживает…
59

Раздел Функциональное назначение
Раздел должен отражать классы решаемых задач и/или назначение программы, сведения о функциональных ограничениях на применение.

Например: Программа предназначена для решения задач … Программа представляет собой ядро автоматизированного рабочего места… Пользователь имеет возможность …., осуществить…, запустить …, проанализировать…, получить результаты анализа и обработки…, построить… и т.п.
60

Раздел Описание логической структуры
В разделе должны быть отражены:
- алгоритм программы;
- используемые методы;
- структура программы с описанием функций составных частей и связей между ними;
- связи программы с другими программами.

Например: Программа состоит из шести модулей: интерфейсный модуль; модуль определения…; модуль расчета…; модуль… и т.п.
Интерфейсный модуль построен на двух типах диалогов: диалог «вопрос-ответ» и диалог типа «меню». Интерфейсный модуль управляет ….
Программа написана на языке… с использованием компилятора…
61

Раздел Используемые технические средства
В разделе должны быть указаны типы ЭВМ и устройств, которые используются при работе программы.

Например: Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа «мышь». Для поддержки графического режима необходим адаптер EGA (VGA). Входные данные хранятся на флоппи- и/или жестком дисках. Программа работает под управлением ОС….
62

Раздел Вызов и загрузка
В разделе указывается способ вызова программы с соответствующего носителя данных и входные точки в программу.


Например: Загрузка программы осуществляется набором в командной строке DOS имени загрузочного модуля – SBM80N.EXE с возможным указанием имени файла данных.
63

Раздел Входные данные
Раздел должен отражать:
- характер, организацию и предварительную подготовку входных данных;
- формат, описание и способ кодирования входных данных.


Например: Входными данными для программы является текстовый файл , описывающий расширенную матрицу инциденций графа исследуемой системы.
64

Раздел Выходные данные
Раздел должен отражать:
- характер и организацию выходных данных;
- формат, описание и способ кодирования выходных данных.
Выходными данными являются:
- выводимая на экран графическая и текстовая информация (результаты анализа системы);
- файлы в одном из графических форматов – копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);
- текстовые файлы – отчеты о проведенных исследованиях;
- диагностика состояния системы и сообщения о всех возникших ошибках.
- описание логики составных частей (при необходимости следует составлять описание схем программ).

65

ГОСТ 19.401-78 ЕСПД. Текст программы
Главное правило – текст программы должен быть удобочитаемым.
Обязательные части:
- аннотация,
- содержание,
- основная часть.
66

Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.
Текст каждого программного файла начинается с «шапки», в которой указывается:
- наименование программы;
- автор;
- дата создания программы;
- номер версии;
- дата последней модификации.
67

68

ГОСТ 19.301-79 ЕСПД.
Программа и методика испытаний
Документ содержит описание объекта и цели испытаний, требования к программе и к программной документации, средства и порядок испытаний, а также описание тестовых примеров.
69

Объект испытаний.
Пример: Объектом испытаний является программа …, предназначенная для …
Цель испытаний.
Пример: Проверка надежности функционирования программы.
Требования к программе.
Пример: Функционирование программы не должно приводить к сбою (фатальному нарушению работы системы). Организация диалога должна предусматривать защиту от ввода некорректных данных. Программа должна выдавать диагностику состояния системы и сообщения о любых возникших ошибках… и т.п.
70

Требования к программной документации.
Пример: Состав программной документации, предъявляемой на испытании:
- описание программы (ГОСТ 19.402-78);
- программа и методика испытаний (ГОСТ 19.301-79);
- текст программы (ГОСТ 19.401-78).
Средства и порядок испытаний.
Пример: Программа работает в соответствии с условиями эксплуатации OC MS DOS (версия не ниже 3.0) на ПК типа IBM PC/AT, а также на совместимых с ним. Для работы необходим также адаптер EGA (VGA).
Порядок проведения испытаний:
1. Запуск программы осуществляется…
2. Выбирается …
3. Нажимается…
4. Последовательно выбираются…
71

Тестовые примеры.
Пример: Для проведения испытаний предлагаются…, описание которых содержатся в файлах… Содержимое тестовых файлов и результаты работы программы приведены в Приложении 1.
72

Документ «Программа и методика испытаний» может быть использован и при сертификации программы.
Возможно зарегистрировать Программу… как объект интеллектуальной собственности.
При успешной регистрации программы, авторам выдается свидетельство о регистрации.
Регистрация программы закрепляет за автором права собственности и позволяет ему извлечь из использования программы коммерческую выгоду.
73

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

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

75

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

76

Структурные элементы текстового документа:

Раздел – первая ступень деления, обозначенная номером и снабженная заголовком.
Подраздел – часть раздела, обозначенная номером и имеющая заголовок.
Пункт – часть раздела иди подраздела, обозначенная номером и снабженная заголовком.
Подпункт – часть пункта, обозначенная номером, может иметь заголовок.
Абзац – логически выделенная часть текста, не имеющая номера.
77

Построение документа
Заголовки разделов записывают прописными буквами и размещают симметрично относительно правой и левой границ текста.
Заголовки подразделов записывают с абзацного отступа строчными буквами (кроме первой прописной).
Переносы слов в заголовках не допускаются.
Точку в конце заголовка не ставят.
Каждый раздел рекомендуется начинать с нового листа.
Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
Разделы должны иметь порядковый номер (1, 2 и т.д.).

78

В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделенные точкой (2.1, 3.1 и т.д.).
При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
Внутри подразделов, пунктов и подпунктов могут быть даны перечисления, которые рекомендуется обозначать арабскими цифрами со скобкой: 1), 2) и т.д. Допускается выделять перечисления простановкой тире перед текстом.
Каждый структурный элемент начинается с абзацного отступа.


79

80

Аннотацию размещают на отдельной странице (страницах), снабжают заголовком "АННОТАЦИЯ", как раздел не нумеруют. В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей.
Содержание документа размещают на отдельной странице (страницах), после аннотации снабжают заголовком "СОДЕРЖАНИЕ", не нумеруют как раздел и включают в общее количество страниц документа. В содержании документа дается перечисление наименований разделов, подразделов, пунктов и подпунктов, имеющих заголовок, их наименование и номера страниц. Наименования, включенные в содержание, записывают строчными буквами. Прописными печатаются заглавные буквы и аббревиатуры.

81

Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии – общепринятым в научно-технической литературе и приводиться в перечне терминов.
Допускаются сокращения слов в тексте по ГОСТ 2.316.
Допускается для выделения отдельных понятий печатать слова или части текста шрифтом, отличным от печати основного текста.
Пояснения к тексту могут оформляться сносками.
82

Иллюстрации
Название рисунка
Рисунок
Подрисуночный текст (может быть, может не быть)
Номер рисунка (Рис. 12)

- Иллюстрации, если их в документе более одной, нумеруют арабскими цифрами в пределах всего документа.
- Ссылки на иллюстрации дают по типу «рис.12», или (рис.12).

83

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

84

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

Таблицы
Цифровой материал для достижения лучшей наглядности и сравнимости показателей следует оформлять в виде таблицы.
Таблица имеет заголовок, который следует выполнять строчными буквами. Прописными печатаются буквы и аббревиатуры.
Оформление таблиц производится в соответствии с требованиями ГОСТ 1.5-2001 «Стандарты межгосударственные, правила и рекомендации по межгосударственной стандартизации».

86

Примечания
В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
Одно примечание не нумеруется.
Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой.
После слова Примечание ставят двоеточие.
Текст примечаний допускается печатать только через один интервал.
87

Сокращения
Сокращения слов в тексте и надписях под иллюстрациями не допускаются, за исключением:
сокращений, установленных в ГОСТ 2.316 и общепринятых в русском языке;
сокращений, применяемых для обозначения программ, их частей и режимов работы, в языках управления заданиями, в средствах настройки программы и т.п., обозначаемых буквами латинского алфавита.
88

Приложения
Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
Приложения оформляют как продолжение данного документа на последующих страницах или выпускают в виде отдельного документа.
Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова "Приложение" и иметь тематический заголовок.
При наличии в документе более одного приложения все приложения нумеруют арабскими цифрами (без знака №), например:
Приложение 1, Приложение 2 и т.д.

89

Разница в оформлении документов по ЕСКД и ЕСПД
90

ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению
Пояснительная записка должна включать следующие разделы:
введение;
назначение и область применения;
технические характеристики;
ожидаемые технико-экономические показатели;
источники, использованные при разработке.
91

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

Назначение и области применения
Указывают назначение программы, краткую характеристику области применения программы.
92

Технические характеристики
В разделе должно содержаться:
- постановка задачи на разработку программы, описание применяемых математических методов и различных ограничений, связанных с выбранным математическим аппаратом;
- описание алгоритма и/или функционирования программы с обоснованием выбора схемы алгоритма решения задачи, возможного взаимодействия программы с другими программами;
- описание и обоснование выбора метода организации входных и выходных данных;
- описание и обоснование выбора состава технических и программных средств на основе проведенных расчетов и анализов, распределение носителей данных, которые использует программа.


93

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

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


94

ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению
Руководство должно содержать следующие разделы:
общие сведения о программе;
структура программы;
настройка программы;
проверка программы;
дополнительные возможности (по желанию);
сообщения системному программисту.
95

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

96

Дополнительные возможности
Раздел должен содержать описание дополнительных разделов функциональных возможностей программы и способов их выбора
Сообщения системному программисту
В разделе необходимо указать тексты сообщений, выдаваемых в ходе выполнения программы, описание содержания и действий, которые необходимо предпринять по этим сообщениям.
97

ГОСТ 19.504-79 ЕСПД. Руководство программиста. Требования к содержанию и оформлению
Должно содержать следующие разделы:
назначение и условия применения программы;
характеристики программы;
обращение к программе;
входные и выходные данные;
сообщения.
98

Назначение и условия применение программы
Указывается назначение и функции, выполняемые программой; условия, необходимые для выполнения программы – объем оперативной памяти, требования к составу и параметрам периферийных устройств; требования к ПО и т.д.
Характеристики программы
Необходимо привести описание основных характеристик и особенностей программы: временных характеристик, режима работы, средств контроля правильности выполнения и самовосстанавливаемости программы и т.д.
Обращение к программе
Представляет собой описание процедур вызова программы (способов передачи управления и параметров данных и др.).

99

Входные и выходные данные
Раздел должен содержать описание организации используемой входной и выходной информации и при необходимости ее кодирования
Сообщения
При описании сообщений необходимо привести тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо предпринять по этим сообщениям.

100

ГОСТ 19.505-79 ЕСПД. Руководство оператора.
Требования к содержанию и оформлению
Руководство оператора должно включать:
назначение программы;
условия выполнения программы;
выполнение программы;
сообщения оператору.
101

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

102

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

ГОСТ 19.506-79. ЕСПД. Описание языка.
Требования к содержанию и оформлению
Необходимые основные разделы:
общие сведения;
элементы языка.
Дополнительные разделы:
способы структурирования программы;
средства обмена данными;
встроенные элементы;
средства отладки.


104

Общие сведения
Должны содержать назначение и описание общих характеристик языка, его возможностей, основных областей применения и др.
Элементы языка
Приводят описание синтаксиса и семантики базовых и составных элементов языка.
105

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