Лекция №10

Лекция №11

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

Стандарты ЕСПд (как и другие ГОСТы) подразделяют на 1уIIпы, приведенные в табл. 3.1.

Обозначение стандарта ЕСПд должно состоять из:

• (присвоенных классу стандартов ЕСПд);

• ОДНОЙ цифры (после точки), обозначающей код классификационной группы Стандартов, указанной в таблице;

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

Вообще перечень документов ЕСПд очень обширен.

следующие ГОСТы

ГОСТ 19.001—77 ЕСПд. Общие положения.

ГОСТ 19.005—85 ЕСПд. Р-схемы алгоритмов и программ. Обозначения условные графические и правила выполнения. ОСТ 19.101—77 ЕСПд. Виды программ и программных документов.

ГОСТ 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 ЕСПд. Описание программы.

ГОСТ 19.403 79 ЕСПд. Ведомость держателей подлинников.

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

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

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

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

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

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

ГОСТ 19.506—79 ЕСПд. Описание языка. Требования к содержа. нию и оформлению.

ГОСТ 19.507—79 ЕСПд. Ведомость эксплуатационных докумен тов.

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

ГОСТ 19.601—78 ЕСПд. Общие правила дублирования, учета в хранения.

ГОСТ 19.602—78 ЕСПд. Правила дублирования, учета и хранения программных документов, выполненных печатным образом.

ГОСТ 19.603—78 ЕСПд. Общие правила внесения изменений.

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

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

ГОСТ 1978 1—90. Обеспечение систем обработки информации программное. Термины и определения.

II режде чем приступить к рассмотрению правил составления раммиой документации, необходимо сделать следующее за‚пие. Каждый документ желательно предварять некоторым щщжием. Во введении говорится об актуальности о необходикiИ и т.п. Цель исполнителя здесь — показать значимость и 1iходимость выполнения этой работы.

1Iз всех стандартов ЕСПд остановимся только на тех, котомогут чаще использоваться на практике.

II ервьим укажем стандарт, который устанавливает виды прои программных документов для вычислительных машин,

4,мiiлексов и систем независимо от их назначения и области приц iIСНиЯ.

ГОСТ 19.1О1—77 ЕСПд. Виды программ

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

ГОСТ подразделяет программы на следующие виды:

Компонент программа рассматриваемая как единое целое, «,щолняющая законченную функцию и применяемая самостоя1 ЬНО ИЛИ в составе комплекса.

Комплекс — программа состоящая из двух или более КОМПО‘1 цтОв, iполняющих взаимосвязанные функции, и применяемая ‚;дОСтоятелъно или в составе другого комплекса.

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

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

Спецiлфикация — содержит состав программы и документаIЩЮ на нее.

Ведомость держателей подлинников — содержит перечень предприятий, на которых хранят подлинники программных доIсументов.

Текст программы — представляет запись программы с неободимыми комментариями.

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

и методика испытаний содержит тРебовани4 подлежащие проверке при испытании программы, а также г док и методы их контроля.

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

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

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

Рассмотрим виды и содержание этих документов (табл.

разрабатывае

Программа

п зависимости от способа выполнения и характера примене1 рограммные документы подразделяются на подлинник, дуби копию (ГОСТ 2.102—68), предназначенные для разработ$1 iчiровождения и эксплуатации программы.

Iассмотрим виды программных документов на разных стадиях, и их коды (табл. 3.3).

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

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

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

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

допускается объединять, исключать этапы работ и (или) иi содержание, а также вводить другие этапы работ по согласова нию с заказчиком.

к прогроммным документам

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

ГОСТ 19.105—78 ЕСГIд. Общие требования ц%1Iс1{ения и предусмотренных стандартами Единой системы проМНОЙ документации (ЕСПд) для любого способа выполне о 1 окументов на различных носителях данных.

11 рограммнъiй документ может быть представлен на разлиЧ1 ипах носителей данных и состоит из следующих условных

i;IушНОЙ;

• iформагжионной;

• повной.

1 ‚ранила оформления документа и его частей на каждом носи

данных устанавливаются стандартами ЕСПд на правила 1 11 рмления документов на 00ветствуюЩИХ носителях данных.

[итулыiая часть оформляется согласно ГОСТ 19.1О?8.

информационная часть должна состоять из нНотациИ и сочканиЯ. В ннотации приводят сведения о назначении доку1 ’1 [ и краткое изложение основной части. Содержание включа1 iсречень записей о структурных элементах основной части )1умента.

Состав и структура основной части программного документа ус- 1 II iвливаются стандартами ЕСПд на 00ветствуюЩие документы.

Техническое задание (ТЗ) содержит совокупность требований 1 IС и может использоваться как критерий проверки и приемки

‚зработанной программы. поэтому достаточно полно состав-

1 i iное (с учетом возможности внесения дополнительных разде

Н) в) и принятое заказчиком и разработчиком тз является одним

о 00ополагающих документов проекта ПС.

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

• введение;

• основания для разработки;

• назначение разработки;

требования к программе или программномУ изделию;

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

• техникоэкономические показатели;

• стадии и этапы разработки;

• порядок контроля и приемки;

• в техническое задание допускается включать приложения.

107

ГОСТ ‚9.20’ —7В ЕСIIД. Техническое задание. Требования к содержаниЮ и оформлению

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

Содержание разделов ТЗ мы рассмотрим позднее, а пока ра смотрим только требования i програiной докугiентации. В даi ном разделе должны быть указаны предварительный состав пр граммной документации и при необходимости специальные тр бования к ней.

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

данный стандарт определяет состав и требования к содерж нию программного документа «Описание программы».

Описание программы включает:

1. Общие сведения.

2. Функциональное назначение.

3. Описание логической структуры.

4. Используемые технические средства.

5. Вызов и загрузка.

б. Входные данные.

7. Выходные данные.

В разделе Общие сведения указывают:

• обозначение и наименование программы;

• программное обеспечение, необходимое для функционирова ния программы;

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

решаемых задач и/или назначение программы, сведения о фуню.i циональных ограничениях на применение.

При описании логической структуры должны быть отражены:

• алгоритм программы;

• используемые методы;

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

• связи программы с другими программами.

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

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

1’. i щел Входные данные отражает:

.‚рктер, организацию и предварительную подготовку входщi’ данных;

)рмат, описание и способ кодирования входных данных.

р’щел Выходные данные отражает:

а рактер и организацию выходных данных;

а рмат, описание и способ кодирования выходных данных.

ГОСТ 19.404—79 ЕСЯД. ПоясииТельиая записка.

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

(огласно данному стандарту пояснительная записка должна н ючать следующие разделы:

1 Введение.

Назначение И область применени1я.

. Технические характеристики.

4. Ожидаемые техникоэкономические показатели.

. ИсточниКИ использоваиньие при разработке.

Иведенiiе должно содержать наименование программы и/или i4йiачение темы разработки а также документы, на основе кор.к ведется разработка.

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

1 разделе Технические характеристики содержатся

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

оизаннЫХ с выбранным математическим аппаратом;

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

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

В качестве ожидаемых техникоэкономических показателей iываЮТ показатели, 00новывающие преимущество выбранiо варианта технического решения а также при необходимос 1 ожидаемые оперативные показатели.

Руководство системного программиста должно содержать с дующие разделы:

1. Общие сведения о программе.

2. Структура программы.

З. Настройка программы.

4. Проверка программы.

5. дополнительные возможности.

б. Сообщения системному программисту.

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

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

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

Раздел Настройка программы должен содержать описание д ствий по настройке программы на условия конкретного пр нения.

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

Раздел Дополiштелыиые возможности должен содержать сание дополнительных разделов функциональных возможно< программы и способов их выбора.

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

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

ГОСТ 19.503—79 ЕСПд. Руководство системного

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

Найти на этой странице