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

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

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

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

Содержание:

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

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

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

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

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

6. Ведомость держателей подлинников

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

8. Формуляр

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

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

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

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

13. Описание языка

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

15. Руководство по техническому обслуживанию

16. Оформление алгоритмов

Таблица 4.7.

 

Вид программного продукта	Содержание программного документа
Спецификация	Состав программы и докумен-тации на нее
Ведомость держателей подлинников	Перечень предприятий, на которых хранят подлинники программных документах
Текст программы	Запись программы с необходи-мыми комментариями
Описание программы	Сведения о логической структуре и функционировании программы
Программа и методика испытаний	Требования, подлежащие проверке при испытании программы, а также порядок и методы их контроля
Техническое задание	Назначение и область применения про - граммы, технические, технико-эконо - мические и специальные требования, предъявляемые к программе, необходи - мые стадии и сроки разработки, виды испытаний
Пояснительная записка	Схема алгоритма, общее описание алго - ритма и (или) функционирования про- граммы, а также обоснование принятых технических и технико-экономических решений
Эксплуатационные документы	Сведения для обеспечения функциони - рования и эксплуатации программы

Таблица 4.8.

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

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

Программный документ состоит из следующих условных частей (ГОСТ 19.105-78):

1. титульной;

2. информационной;

3. основной;

4. регистрации изменений.

4.3.2.1. Титульная часть

Титульная часть состоит из:

а) листа утверждения;

б) титульного листа.

Основные надписи листа утверждения и титульного листа. Надписи листа утверждения и титульного листа в программных документах по ГОСТ 19.104-78.

Лист утверждения заполняется по форме, приведенной на рис. 4.3:

а) поле 1 - наименование министерства или ведомства, в систему которого входит данная организация, разработавшая данный документ.

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

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

г) поле 4 - обозначение документа и указания вида носителя данных;

д) поле 5 - общее количество листов утверждения (для одного листа утверждения поле 5 не заполняют);

е) поле 6 - в правой части поля-должности и подписи руководителя организации, выпустившего документ, руководителя подразделения, разработавшего документ, разработчика, исполнителей разработки документа и нормоконтролера;

ж) поле 7 - год издания (утверждения) документа (без указания слова г “год”);

з) поле 8 - отметка об учете и хранении по ГОСТ 19.601-78;

и) поле 9 - строка изменений по ГОСТ 19.604.78;

к) поле 10 - литера документа.

Лист утверждения выпускается на каждый программный документ на листах бумаги А4 (ГОСТ 2.301-68) независимо от вида документа, который может быть выполнен на любом носителе данных. Обозначение листа утверждения состоит из обозначения документа, к которому относится лист утверждения, и через дефис шифра ЛУ. Лист утверждения не входит в общее количество листов документа.

Титульный лист заполняют по правилам и форме, установленным для листа утверждения, при этом:

а) поле 1 - заполняют по требованию заказчика. На титульном листе в верхнем углу должна быть надпись “Утвержден” обозначение ЛУ;

б) поле 2 - не заполняют;

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

г) поле 4 - обозначение документа и указания вида носителя данных;

д) поле 5 - указывают объем документа;

е) поле 6 - не заполняют;

ж) поле 7 - год издания (утверждения) документа;

з)поле 8 - отметка об учете и хранении по ГОСТ 19.601-78;

и) поле 9 - строка изменения по ГОСТ 19.604.78;

к) поле 10 - литера документа.

 

4.3.2.2. Информационная часть

Информационная часть должна состоять из:

а) аннотации;

б) содержания;

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

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

4.3.2.3. Основная часть

Состав и структура основной части программного документа устанавливается стандартами ЕСПД на соответствующие документы.

 

Основная часть включает в себя (ГОСТ 19.106-78):

а) текст документа (с рисунками, таблицами и т. п.);

б) приложение;

в) перечень терминов;

г) перечень сокращений;

д) перечень рисунков;

е) перечень таблиц;

ж) предметный указатель;

з) перечень ссылочных документов;

и) перечень символов и числовых коэффициентов.

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

Информационная и основная части программного документа выполняются по форме. Рамку (границы) формата страниц допускается не наносить.

Часть регистрации изменений должна содержать:

- лист регистрации изменений.

О каждом изменении программного документа в этой части делается запись в соответствии с требованием ГОСТ 19.603-78.

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

Программный документ выполняют одним из следующих печатных способов (ГОСТ 19.106-78):

а) машинописный - на одной стороне листа, через два интервала (допускается через один или полтора интервала, если допускается к микрофильмированию);

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

в) типографский - в соответствии с требованиями, предъявляемыми к изданиям, изготовляемым типографским способом.

Допускается выполнение документа или его части рукописным способом на одной стороне листа черными чернилами или тушью, основным чертежным шрифтом по ГОСТ 2.304-81 с высотой букв не менее 2,5 мм.

Программные документы оформляют:

а) на листах формата А4 (ГОСТ 2.301-68)-при изготовлении документа машинописным или рукописными способами;

б) на листах формата А3 (А4) - при изготовлении документа машинным способом;

в) на листах типографских форматов - при изготовлении документа типографским способом.

 

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

Техническое задание должно содержать следующие разделы (ГОСТ-19.201-78):

а) в разделе “Введение“ указывают наименование, краткую характеристику области применения программы или программного изделия и объекта, в котором используют программу или программное изделие.

б) в разделе “Основание для разработки“ должны быть указаны документы, на основании которых ведется разработка, наименование темы разработки.

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

г) раздел “Требования к программе или программному изделию“ должен содержать следующие подразделы:

д) раздел “Требования к функциональным характеристикам“ - требования к составу выполняемых функций, организации входных и выходных данных, временным характеристикам;

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

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

з) раздел “Требования к составу и параметрам технических средств“ - необходимый состав технических средств с указанием их основных технических характеристик;

и) раздел “ Требования к информационной и программной совместимости ” - требования к информационным структурам на входе и на выходе и методам решения, исходным кодам, языкам программирования и программным средствам, используемым программой;

к) раздел “Требования к маркировке и упаковке“ - требования к маркировке программного изделия, варианты и способы упаковки;

л) раздел “Требования к транспортированию и хранению“ - условия транспортирования, места хранения, условия хранения и условия складирования, сроки хранения в различных условиях.

м) в разделе “Требования к программной документации“ - должен быть указан предварительный состав программной документации и при необходимости специальные требования к ней;

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

о) в разделе “Стадии и этапы разработки“ устанавливают необходимые стадии разработки, этапы, и содержание работ, а также сроки разработки и определяют исполнителей;

п) в разделе “Порядок контроля и приемки“ должны быть указаны виды испытаний и общие требования приемки работы.

В приложениях к техническому заданию, при необходимости приводят:

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

 

 

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

Спецификация является основным программным документом для компонентов, применяемых самостоятельно и для комплексов (ГОСТ 19. 202 - 78). Для компонентов, не имеющих спецификации основным программным документом является “ Текст программы “.

Спецификация состоит из трех граф:

- обозначение;

- наименование;

- примечание.

Спецификация в общем случае должна содержать следующие разделы:

- документация;

- комплексы;

- компоненты.

Графы спецификации заполняются следующим образом. В графе “Обозначение“ указывают:

в разделе “Документация “ - обозначения записываемых документов программы;

в разделе “ Комплексы “ - обозначение спецификаций комплексов, входящих в данный комплекс;

в разделе “ Компоненты “ - обозначение основных программных компонентов.

в графе “Наименование “ указывают:

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

в разделах “Комплексы“ и “Компоненты“ - полное наименование программы, наименование и вид документа.

В графе “ Примечание “ - дополнительные сведения, относящиеся к записанным в спецификации программам.

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

Документ “ Программа и методика испытаний “ должен содержать следующие разделы (ГОСТ 19. 301-79):

а) объект испытаний - указывают наименование, область применения и обозначение испытуемой программы;

б) цель испытаний - указывает цель проведения испытаний;

в) требования к программе - указывают требования, подлежащие проверке

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

г) требования к программной документации - указывают состав программной документации, предъявляемой на испытания, а также специальные требования, если они заданы в техническом задании на программу;

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

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

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

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

Документ “Текст программы“ должен состоять из текстов одного или нескольких разделов, которым даны наименования (ГОСТ 19.401-78). Каждый из разделов реализуется одним из типов символической записи, например:

а) символическая запись на исходном языке;

б) символическая запись на промежуточных языках;

в) символическое представление машинных кодов и т. п.

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

Документ “Описание программы“ должен содержать следующие разделы (ГОСТ 19. 402-78):

а) “Общие сведения“ - указывается обозначение и наименование программы, программное обеспечение, необходимое для функционирования программы, языки программирования на которых написана программа;

б) “Функциональное назначение“ - указываются классы решаемых задач, назначение программы, сведения о функциональных ограничениях на применения;

в) “Описание логической структуры“ - указываются алгоритм программы, используемые методы, структура программы с описанием функций составных частей и связей между ними, связи программы с другими программами;

г) “Используемые технические средства“ - указываются типы электронных вычислительных машин и устройства, которые используются при работе программы;

д) “Вызов и загрузка“ - способ вызова программы с соответствующего носителя данных, входные точки в программу, допускается указывать адреса загрузки, сведения об используемой оперативной памяти, объем программы;

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

ж) “Выходные данные“ - характер и организация выходных данных, формат, описания и способ кодирования выходных данных.

4.3.3.6. Ведомость держателей подлинников

“Ведомость держателей подлинников“ составляют на основании спецификации программы и спецификации входящих программ (ГОСТ 19.403-79). Ведомость состоит из четырех граф.

В графе - “Обозначение“ указывают обозначение по спецификации по ГОСТ 19.103-77.

В графе - “Наименование“ приводят полное наименование программы в соответствии с наименованием, указанным на листе утверждения или титульном листе.

В графе - “Держатель подлинника“ указывают ведомственную принадлежность и наименование организации держателя подлинника.

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

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

Пояснительная записка должна содержать следующие разделы (ГОСТ 19.404-79):

а) “Введение“ - указывает наименование программы и условное обозначение темы разработки;

б) “Назначение и область применения“ - указывают назначение программы, краткую характеристику области применения программы;

в) “Технические характеристики“ - должен содержать следующие подразделы:

1) постановка задачи на разработку программы, описание применяемых математических методов и, при необходимости, описание допущений и ограничений, связанных с выбранным математическим аппаратом;

2) описание алгоритма и функционирование программы с обоснованием выбора схемы алгоритма решения задачи;

3) описание и обоснование выбора метода организации входных и выходных данных;

4) описание и обоснование выбора состава технических и программных средств на основании приведенных расчетов или анализов, распределение носителей данных, которые использует программа.

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

д) “Источники, используемые при разработке“- указывают перечень научно-технических публикаций, нормативно-технические документы и другие материалы, на которые есть ссылки в документе.

4.3.3.8. Формуляр

Программный документ “Формуляр“ должен содержать следующие разделы

(ГОСТ 19.501-78):

а) в разделе - “Общие указания“ приводят общие указания для обслуживающего персонала по эксплуатации программного изделия;

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

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

г) в разделе - “Комплектность“ перечисляются все непосредственно входящие в программное изделие другие программные изделия и документацию в соответствии с комплектностью, указанной в технических условиях на программное изделие.

д) в разделе - “Периодический контроль основных характеристик при эксплуатации и хранении“ указывают наименование измерения проверяемых характеристик, требуемую периодичность контроля;

е) в разделе - “Свидетельство о приемке“ приводит свидетельства о приемке программного изделия, подписанное лицами, ответственными за приемку;

ж) в разделе - “Свидетельство об упаковке и маркировке “ помечают сведения об упаковке программного изделия, подписанное лицами, ответственными за упаковку;

з) в разделе - “Гарантийные обязательства“ приводят гарантийные обязательства предприятия изготовителя;

и) в разделе - “Сведения о рекламациях“ приводят краткое изложение порядка предъявления рекламации и регистрируют все предъявленные рекламации и регистрируют все предъявленные рекламации, их содержание принятые меры;

к) в разделе - “Сведения о хранении “ указывают сроки хранения и условия хранения программного изделия;

л) в разделе - “Сведения о закреплении программного изделия при эксплуатации“ указывают фамилии и должности лиц, за которыми закрепляют программное изделие;

м) в разделе - “Сведения об изменениях“ указывают основание для внесения изменений;

н) в разделе - “Особые отметки“ оставляют несколько чистых листов для внесения особых отметок во время эксплуатации.

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

Текст документа “ Описание применения “ должен состоять из следующих разделов (ГОСТ 19. 502-78):

а) в разделе - “Назначение программы“ указывают назначение, возможности программы, ее основные характеристики, ограничения, накладываемые на область применения программы;

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

в) в разделе - “Описание задачи“ должны быть указаны определения задачи и методы ее решения;

г) в разделе - “Входные и выходные данные» должны быть указаны сведения о входных и выходных данных.

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

Программный документ “ Руководство системного программиста “ должен содержать следующие разделы (ГОСТ 19. 503-79):

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

б) в разделе - “Структура программы“ должны быть приведены сведения о структуре программы, ее составных частях и связях между ними;

в) в разделе - “Настройка программы“ должно быть приведено описание действий по настройке программы на условия конкретного применения;

г) в разделе - “Проверка программы” должно быть приведено описание способов проверки, позволяющих дать общее заключение работоспособности программы (контрольные примеры, методы прогона, результаты);

д) в разделе - “Дополнительные возможности“ должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора;

е) в разделе - “Сообщения системному программисту“ должно быть указаны тексты сообщений выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы.

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

Программный документ “Руководство программиста“ должен содержать следующие разделы (ГОСТ 19. 504-79):

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

б) в разделе - “Характеристики программы“ должно быть приведено описание основных характеристик и особенностей программы (временные характеристики, режим работы, средства контроля правильности и само восстанавливаемости программы и т.д.);

в) в разделе - “Обращение к программе“ должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.);

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

д) в разделе - “Сообщения“ должны быть указаны тексты сообщений, выдаваемых оператору или программисту в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям;

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

Программный документ “Руководство оператора“ должен содержать следующие разделы (ГОСТ 19. 505-79):

а) в разделе - “Назначение программы“ указываются сведения о назначении программы и информация достаточная для понимания функций программы и ее эксплуатации;

б) в разделе - “Условия выполнения программы“ должны быть указаны условия, необходимые для выполнения программы (минимальный состав аппаратных и программных средств и т. д.);

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

г) в разделе - “ Сообщения оператору “ должны быть приведены тексты сообщений, выдаваемых в ходе выполнения программы, описание их содержания и соответствующие действия оператора.

 

4.3.3.13 Описание языка

Программный документ “Описание языка“ должен содержать следующие разделы (ГОСТ 19. 506-79):

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

б) в разделе - “Элементы языка“ указано описание синтаксиса и семантики базовых и составных элементов языка;

в) в разделе - “Способы структурирования программы “ указываются способы вызова процедур передачи управления и другие элементы структурирования программы;

г) в разделе - “Средства обмена данными“ приводятся описания языковых средств обмена данными;

д) в разделе - “Встроенные элементы“ приводятся описания встроенных в язык элементов (например, функций и способы их использования);

е) в разделе - “Средства отладки программы“ приводятся описания имеющихся в языке средств отладки программ.

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

Программный документ “Ведомость эксплуатационных документов“ должен состоять из четырех граф (ГОСТ 19. 507-79).

В графе “Обозначение “ указывают обозначение документов по ГОСТ 19.103-77.

В графе “Наименование“ указывают полное наименование эксплуатационного документа в соответствии с наименованием, указанным в листе утверждения или титульном листе.

В графе “Кол. экз.“ указывают количество экземпляров данного документа. В графе “ Местонахождение “ указывают номер папки, в которой хранится документ.

4.3.3.15 Руководство по техническому обслуживанию

Программный документ “Руководство по техническому обслуживанию“ должен содержать следующие разделы (ГОСТ 19. 508-79):

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

б) в разделе - “Общие указания“ указывают порядок технического обслуживания;

в) в разделе - “Требования к техническим средствам“ указывают минимальный состав технических средств, обеспечивающих работу программы;

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

 

4.3.3.16. Оформление алгоритмов

В ГОСТе (ГОСТ 19. 701-90) определены символы предназначенные для использования в документации по обработке данных, и приведено руководство по условным обозначениям применения их в:

- схемах данных;

- схемах программ;

- схемах работы системы;

- схемах взаимодействия программ;

- схемах ресурсов программы.

В стандарте используются следующие понятия:

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

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

- схема - графическое представление определения, анализа или метода решения задач.

Стандарт (ГОСТ 19.005-85) устанавливает условные графические обозначения элементов и структур Р-схем, а также правила их выполнения автоматическим или ручным способами.