Методичка Фролов
.pdf–ГОСТ 19.508–79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению;
–ГОСТ 19.601–78 ЕСПД. Общие правила дублирования, учета и хранения;
–ГОСТ 19.602–78 ЕСПД. Правила дублирования, учета и хранения программных документов, выполненных печатным образом;
–ГОСТ 19.603–78 ЕСПД. Общие правила внесения изменений;
–ГОСТ 19.604–78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом;
–ГОСТ 19.701–90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения;
–ГОСТ 19781–90. Обеспечение систем обработки информации программное. Термины и определения.
Каждый документ желательно предварять некоторым введением, в котором говорится об актуальности, о необходимости и т. п. Цель исполнителя здесь – показать значимость и необходимость выполнения работы.
Далее перечислим стандарты ЕСПД, которые могут чаще всего использоваться на практике.
1.2.1. ГОСТ 19.101–77 ЕСПД. Виды программ и программных документов
ГОСТ подразделяет программы на следующие виды:
Компонент – программа, рассматриваемая как единое целое, выполняющая законченную функцию и применяемая самостоятельно или в составе комплекса.
Комплекс – программа, состоящая из двух или более компонентов, выполняющих взаимосвязанные функции, и применяемая самостоятельно или в составе другого комплекса.
Документация, разработанная на программу, может использоваться для
11
реализации и передачи программы на носителях данных, а также для изготовления программного изделия.
К числу программных данный ГОСТ относит документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ. Рассмотрим виды программных документов и их содержание:
Спецификация – содержит состав программы и документацию на нее.
Ведомость держателей подлинников – содержит перечень предпри-
ятий, на которых хранят подлинники программных документов.
Текст программы – представляет запись программы с необходимыми комментариями.
Описание программы – содержит сведения о логической структуре и функционировании программы.
Программа и методика испытаний – содержит требования, подлежа-
щие проверке при испытании программы, а также порядок и методы их контроля.
Техническое задание – описывает назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний.
Пояснительная записка – содержит схему алгоритма, общее описание алгоритма и (или) функционирования программы, а также обоснование принятых технических и технико-экономических решений.
Эксплуатационные документы – содержат сведения для обеспечения функционирования и эксплуатации программы.
Рассмотрим виды и содержание этих документов (табл. 1.2).
12
|
Таблица 1.2 |
|
|
Вид |
|
эксплуатационного доку- |
Содержание эксплуатационного документа |
мента |
|
|
|
Ведомость эксплуатацион- |
Перечень эксплуатационных документов на программу |
ных документов |
|
|
|
Формуляр |
Основные характеристики программы, комплектность и |
|
сведения об эксплуатации программы |
|
|
Описание применения |
Сведения о назначении программы, области применения, |
|
применяемых методах, классе решаемых задач, ограниче- |
|
ниях для применения, минимальной конфигурации техни- |
|
ческих средств |
|
|
Руководство системного |
Сведения для проверки, обеспечения функционирования |
программиста |
и настройки программы на условия конкретного приме- |
|
нения |
|
|
Руководство программиста |
Сведения для эксплуатации программы |
|
|
Руководство оператора |
Сведения для обеспечения процедуры общения оператора |
|
с вычислительной системой в процессе выполнения про- |
|
граммы |
|
|
Описание языка |
Описание синтаксиса и семантики языка |
|
|
Руководство по обслужива- |
Сведения для применения тестовых и диагностических |
нию |
программ при обслуживании технических средств |
|
|
В зависимости от способа выполнения и характера применения программные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102–68), предназначенные для разработки, сопровождения и эксплуатации программы.
Рассмотрим виды программных документов, разрабатываемых на разных стадиях, и их коды (табл. 1.3).
13
|
|
|
|
|
Таблица 1.3 |
|
|
|
|
|
|
|
|
|
|
|
Стадии разработки |
|
||
Код вида |
|
|
|
|
|
|
Вид документа |
Эскизный |
Техниче- |
Рабочий проект |
|||
|
||||||
документа |
|
проект |
ский про- |
компо- |
комплекс |
|
|
|
|||||
|
|
|
ект |
нент |
|
|
|
|
|
|
|
|
|
– |
Спецификация |
– |
– |
I |
• |
|
|
|
|
|
|
|
|
05 |
Ведомость держателей под- |
– |
– |
– |
О |
|
|
линников |
|
|
|
|
|
|
|
|
|
|
|
|
12 |
Текст программы |
– |
– |
• |
О |
|
|
|
|
|
|
|
|
13 |
Описание программы |
– |
– |
О |
О |
|
|
|
|
|
|
|
|
20 |
Ведомость эксплуатацион- |
– |
– |
О |
О |
|
|
ных документов |
|
|
|
|
|
|
|
|
|
|
|
|
30 |
Формуляр |
– |
– |
О |
О |
|
|
|
|
|
|
|
|
31 |
Описание применения |
– |
– |
О |
О |
|
|
|
|
|
|
|
|
32 |
Руководство системного |
– |
– |
О |
О |
|
|
программиста |
|
|
|
|
|
|
|
|
|
|
|
|
33 |
Руководство программиста |
– |
– |
О |
О |
|
|
|
|
|
|
|
|
34 |
Руководство оператора |
– |
– |
О |
О |
|
|
|
|
|
|
|
|
35 |
Описание языка |
– |
– |
О |
О |
|
|
|
|
|
|
|
|
46 |
Руководство по техническо- |
I |
I |
О |
О |
|
|
му обслуживанию |
|
|
|
|
|
|
|
|
|
|
|
|
51 |
Программа и методика ис- |
I |
– |
О |
О |
|
|
пытаний |
|
|
|
|
|
|
|
|
|
|
|
|
81 |
Пояснительная записка |
О |
О |
– |
– |
|
|
|
|
|
|
|
|
90–99 |
Прочие документы |
О |
О |
О |
О |
|
|
|
|
|
|
|
|
Условные обозначения:
• – документ обязательный;
I– документ обязательный для компонентов, имеющих самостоятельное применение; О – необходимость составления документа определяется на этапе разработки и утверждения технического задания;
– – документ не составляют.
14
Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов. В объединенных документах должны быть приведены сведения, которые необходимо включать
вкаждый объединяемый документ.
1.2.2.ГОСТ 19.102–77 ЕСПД. Стадии разработки
Устанавливает стадии разработки программ и программной документации для вычислительных машин, комплексов и систем независимо от их назначения и области применения (табл. 1.4).
|
|
Таблица 1.4 |
|
|
Стадии разработки, этапы и содержание работ |
||
|
|
|
|
Стадия |
Этап работы |
Содержание работ |
|
разработки |
|||
|
|
||
|
|
|
|
Техническое |
Обоснование |
Постановка задачи. Сбор исходных материалов. Вы- |
|
задание |
необходимости |
бор и обоснование критериев эффективности и каче- |
|
|
разработки |
ства разрабатываемой программы. Обоснование необ- |
|
|
программы |
ходимости проведения научно-исследовательских |
|
|
|
работ |
|
|
|
|
|
|
Научно- |
Определение структуры входных и выходных данных. |
|
|
исследовательские |
Предварительный выбор методов решения задач. |
|
|
работы |
Обоснование целесообразности применения ранее |
|
|
|
разработанных программ. |
|
|
|
Определение требований к техническим средствам. |
|
|
|
Обоснование принципиальной возможности решения |
|
|
|
поставленной задачи |
|
|
|
|
|
15
|
|
Продолжение табл. 1.4 |
|
Стадия |
Этап работы |
Содержание работ |
|
разработки |
|||
|
|
||
|
|
|
|
|
Разработка и |
Определение требований к программе. |
|
|
утверждение |
Разработка технико-экономического обоснования раз- |
|
|
технического |
работки программы. |
|
|
задания |
Определение стадий, этапов и сроков разработки про- |
|
|
|
граммы и документации на нее. Выбор языков про- |
|
|
|
граммирования. Определение необходимости прове- |
|
|
|
дения научно-исследовательских работ на последую- |
|
|
|
щих стадиях. Согласование и утверждение |
|
|
|
технического задания |
|
|
|
|
|
Эскизный |
Разработка |
Предварительная разработка структуры входных и |
|
проект |
эскизного проекта |
выходных данных. Уточнение методов решения зада- |
|
|
|
чи. Разработка общего описания алгоритма решения |
|
|
|
задачи. Разработка технико-экономического обосно- |
|
|
|
вания |
|
|
|
|
|
|
Утверждение |
Разработка пояснительной записки. Согласование и |
|
|
эскизного проекта |
утверждение эскизного проекта. |
|
|
|
|
|
Технический |
Разработка |
Уточнение структуры входных и выходных данных. |
|
проект |
технического |
Разработка алгоритма решения задачи. |
|
|
проекта |
Определение формы представления входных и вы- |
|
|
|
ходных данных. Определение семантики и синтаксиса |
|
|
|
языка. |
|
|
|
Разработка структуры программы. Окончательное оп- |
|
|
|
ределение конфигурации технических средств |
|
|
|
|
|
|
Утверждение |
Разработка плана мероприятий по разработке и вне- |
|
|
технического |
дрению программ. Разработка пояснительной записки. |
|
|
проекта |
Согласование и утверждение технического проекта |
|
|
|
|
|
Рабочий |
Разработка |
Программирование и отладка программы |
|
проект |
программы |
|
|
|
|
|
16
|
|
Окончание табл. 1.4 |
|
Стадия |
Этап работы |
Содержание работ |
|
разработки |
|||
|
|
||
|
|
|
|
|
Разработка |
Разработка программных документов в соответствии с |
|
|
программной |
требованиями ГОСТ 19.101–77 |
|
|
документации |
|
|
|
|
|
|
|
Испытания |
Разработка, согласование и утверждение программы и |
|
|
программы |
методики испытаний. |
|
|
|
Проведение предварительных государственных, меж- |
|
|
|
ведомственных, приемо-сдаточных и других видов |
|
|
|
испытаний. |
|
|
|
Корректировка программы и программной докумен- |
|
|
|
тации по результатам испытаний |
|
|
|
|
|
Внедрение |
Подготовка и |
Подготовка и передача программы и программной до- |
|
|
передача |
кументации для сопровождения и (или) изготовления. |
|
|
программы |
Оформление и утверждение акта о передаче програм- |
|
|
|
мы на сопровождение и (или) изготовление. Передача |
|
|
|
программы в фонд алгоритмов и программ |
|
|
|
|
Допускается исключать вторую стадию разработки, а в технически обоснованных случаях – вторую и третью стадии. Необходимость проведения этих стадий указывается в техническом задании.
Допускается объединять, исключать этапы работ и (или) их содержание, а также вводить другие этапы работ по согласованию с заказчиком.
1.2.3. ГОСТ 19.105–78 ЕСПД. Общие требования к программным документам
Данный стандарт устанавливает общие требования к оформлению программных документов для вычислительных машин, комплексов и систем независимо от их назначения и области применения и предусмотренных стандартами Единой системы программной документации (ЕСПД) для лю-
17
бого способа выполнения документов на различных носителях данных. Программный документ может быть представлен на различных типах
носителей данных и состоит из следующих условных частей:
–титульной;
–информационной;
–основной.
Правила оформления документа и его частей на каждом носителе данных устанавливаются стандартами ЕСПД на правила оформления документов на соответствующих носителях данных.
Титульная часть оформляется согласно ГОСТ 19.104–78. Информационная часть должна состоять из аннотации и содержания. В
аннотации приводят сведения о назначении документа и краткое изложение основной части. Содержание включает перечень записей о структурных элементах основной части документа.
Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.
1.2.4. ГОСТ 19.201–78 ЕСПД. Техническое задание. Требования к содержанию и оформлению
Техническое задание (ТЗ) содержит совокупность требований к программному средству и может использоваться как критерий проверки и приемки разработанной программы. Поэтому достаточно полно составленное (с учетом возможности внесения дополнительных разделов) и принятое заказчиком и разработчиком ТЗ является одним из основополагающих документов проекта ПС.
Техническое задание должно содержать следующие разделы:
–введение;
–основания для разработки;
18
–назначение разработки;
–требования к программе или программному изделию;
–требования к программной документации;
–технико-экономические показатели;
–стадии и этапы разработки;
–порядок контроля и приемки;
–в техническое задание допускается включать приложения.
В зависимости от особенностей программы или программного изделия допускается уточнять содержание разделов, вводить новые разделы или объединять отдельные из них.
1.2.5. ГОСТ 19.301–79 ЕСПД. Программа и методика испытаний. Требования к содержанию и оформлению
Структура и оформление документа устанавливается в соответствии с ГОСТ 19.105–78.
Составление информационной части (аннотации и содержания) является необязательным.
Документ «Программа и методика испытаний» должен содержать следующие разделы:
–объект испытаний;
–цель испытаний;
–требования к программе;
–требования к программной документации;
–состав и порядок испытаний;
–методы испытаний.
Взависимости от особенностей документа допускается вводить дополнительные разделы.
Вразделе «Объект испытаний» указывают наименование, область при-
19
менения и обозначение испытуемой программы.
Вразделе «Цель испытаний» должна быть указана цель проведения испытаний.
Вразделе «Требования к программе» должны быть указаны требования, подлежащие проверке во время испытаний и заданные в техническом задании на программу.
Вразделе «Требования к программной документации» должны быть указаны состав программной документации, предъявляемой на испытания,
атакже специальные требования, если они заданы в техническом задании на программу.
Вразделе «Средства и порядок испытаний» должны быть указаны технические и программные средства, используемые во время испытаний, а также порядок проведения испытаний.
Вразделе «Методы испытаний» должны быть приведены описания используемых методов испытаний. Методы испытаний рекомендуется по отдельным показателям располагать в последовательности, в которой эти показатели расположены в разделах «Требования к программе» и «Требования к программной документации».
Вметодах испытаний должны быть приведены описания проверок с указанием результатов проведения испытаний (перечней тестовых примеров, контрольных распечаток тестовых примеров и т. п.).
Вприложение к документу могут быть включены тестовые примеры, контрольные распечатки тестовых примеров, таблицы, графики и т. п.
1.2.6. ГОСТ 19.401–78 ЕСПД. Текст программы. Требования к содержанию и оформлению
Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105–78.
Составление информационной части (аннотация и содержание) является
20
