Программная документация гост

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

Общая характеристика состояния

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

Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки ПС, и связаны, по большей части, с документированием функциональных характеристик ПС. Следует отметить, что стандарты ЕСПД (ГОСТ 19) носят рекомендательный характер. Впрочем, это относится и ко всем другим стандартам в области ПС (ГОСТ 34, Международному стандарту ISO/IEC, и др.). Дело в том, что в соответствии с Законом РФ "О стандартизации" эти стандарты становятся обязательными на контрактной основе — то есть при ссылке на них в договоре на разработку (поставку) ПС.

Говоря о состоянии ЕСПД в целом, можно констатировать, что большая часть стандартов ЕСПД морально устарела.

К числу основных недостатков ЕСПД можно отнести:

· ориентацию на единственную, "каскадную" модель жизненного цикла (ЖЦ) ПС;

· отсутствие четких рекомендаций по документированию характеристик качества ПС;

· отсутствие системной увязки с другими действующими отечественными системами стандартов по ЖЦ и документированию продукции в целом, например, ЕСКД;

· нечетко выраженный подход к документированию ПС как товарной продукции;

· отсутствие рекомендаций по самодокументированию ПС, например, в виде экранных меню и средств оперативной помощи пользователю ("хелпов");

· отсутствие рекомендаций по составу, содержанию и оформлению перспективных документов на ПС, согласованных с рекомендациями международных и региональных стандартов.

Итак, ЕСПД нуждается в полном пересмотре на основе стандарта ИСО/МЭК 12207-95 на процессы жизненного цикла ПС об этом стандарте далее будет сказано подробнее).

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

Международный стандарт ISO/IEC 12207: 1995-08-01 на организацию ЖЦ продуктов программного обеспечения (ПО) — казалось бы весьма неконкретный, но вполне новый и отчасти "модный" стандарт.

Стандарты комплекса ГОСТ 34 на создание и развитие автоматизированных систем (АС) — обобщенные, но воспринимаемые как весьма жесткие по структуре ЖЦ и проектной документации. Но эти стандарты многими считаются бюрократическими до вредности и консервативными до устарелости. Насколько это так, а насколько ГОСТ 34 остается работающим с пользой — полезно разобраться.

В своей статье Е.З.Зиндер подробно останавливается на методике Oracle CDM (Custom Development Method) по разработке прикладных информационных систем под заказ — конкретный материал, детализированный до уровня заготовок проектных документов, рассчитанных на прямое использование в проектах АС с опорой на инструментарий Oracle.

Краткое представление стандартов ЕСПД

Тем не менее, до пересмотра всего комплекса, многие стандарты ЕСПД могут с пользой применяться в практике документирования ПС. Эта позиция основана на следующем:

· стандарты ЕСПД вносят элемент упорядочения в процесс документирования ПС;

· предусмотренный стандартами ЕСПД состав программных документов вовсе не такой "жесткий", как некоторым кажется: стандарты позволяют вносить в комплект документации на ПС дополнительные виды

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

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

Стандарты ЕСПД (как и другие ГОСТы) подразделяют на группы, приведTнные в таблице:

Kод группы Наименование группы
Общие положения
Основополагающие стандарты
Правила выполнения документации разработки
Правила выполнения документации изготовления
Правила выполнения документации сопровождения
Правила выполнения эксплуатационной документации
Правила обращения программной документации
Резервные группы
Прочие стандарты

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

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

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

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

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

Перечень документов ЕСПД

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

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

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 ЕСПД. Описание языка.

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

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

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

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

Термины и определения

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

Первым укажем стандарт, который можно использовать при формировании заданий на программирование.

ГОСТ (СТ СЭВ) 19.201-78 (1626-79). ЕСПД. Техническое задание. Требование к содержанию и оформлению. (Переиздан в ноябре 1987г с изм.1).

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

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

· введение;

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

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

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

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

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

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

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

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

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

Следующий стандарт
ГОСТ (СТ СЭВ) 19.101-77 (1626-79).

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

Виды программ

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

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


" Форма 14

гриф при необходимости

Экз. №

  " УТВЕРЖДАЮ  
  * должность  
Личная подпись ПЗ при РА ОКР Расшифрозка подписи

— — УТВЕРЖДАЮ
.. должность
Личная подпись *П4 ОКР Расшифровка подписи

Дата

Дата

СОГЛАСОВАНО*

должность

Личная подпись

Дата

изготовитель установочной серии

Расшифровка подписи

АКТ проверки конструкторской и технологической документации

наименование, тип КИМП

город . .
На основании Решения по акту приемки шьггно-конструкторской работы, утвержденного «__ » ,

20___ г.,____________________ :_________ и______________________ * была проведена проверка комп-

ГИ ОКР изготовитель КИМП

, разработанных в результа-

лектов конструкторской и технологической .документации

наименование темы по плану

те выполнения опытно-конструкторской работы______

шифр

* Помещают при выполнении GKP с одновременным освоением производства.

** В, необходимых случаях разрешается указывать только шифр темы.

ГОСТ РВ 15.205—2004

По результатам проверки бьшо установлено, что комплекты конструкторской и технологической документа-»
ции доработаны полностью по замечаниям государственной комиссии по приемке ОКР.
На документации следует проставить литеру ____ , *

Представители заказчика:

П редставител и* .изготовителя установоч­ной серии:

Представители Г\А ОКР:

должность

должность

должность

ЛЗ при ГИ ОКР

Личная Расшифровка

подпись подписи

Личная подпись

Расшифровка подписи —

Личная ‘ . подлись

Расшифровка подписи

Дата

Дата

Дата

должность

должность

должность

ПЗ при изготовителе установочной сер^и „

Личная Расшифровка

подпись подписи

-Личная подпись

Расшифровка подписи’

Личная подлись

Расшифровка подписи

Дата’

Дата

Дата

* Помещают при выполнении ОКР с одновременным освоением производства.

ГОСТ РВ 15,205—2004

• .. • Приложение Г .. ‘ . ♦ л

(рекомендуемое) •

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

,’ •_ ГЛ При разработке эскизного проекта ОКР с учетом требований ГОСТ 2.119^зыполняют’работы, необходи­
мые для обеспечения предъявляемых к КИМП требований 73м позволяющие установить принципиальные реше­
ния по КИМП, * " *

Г2 В о(5щем случае при разработке эскизного проекта ОКР выполняют следующие работы:’

— разработку вариантов^ возможных решений, установление особенностей вариантов, их конструктивную и технологическую проработку. Глубина такой проработки должна быть достаточной для сопоставления рассматри­ваемых вариантов; * — • ‘ , . • *

— разработку и обоснование технических решений,~направленных*на обеспечение.показателей надежное^ ти, установленных ТЗ; составление ПОКр’или ПОНр в соответствии с 5.2.5 настоящего стандарта; ‘

— изготовление и испытание макетов с целью проверки принципов работы КИМП в объёме, необходимом* для оценки правильности намеченных решений в соответствии с ТЗ; ^

— выбор оптимального варианта (вариантов) КИМП, обоснование выбора; принятие принципиальных’реше- ‘ ний по предъявляемым к КИМП требованиям'(технических характеристик* показателей качества и др.), установ­ленным в ТЗ; -..’.;.

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

необходимости); * е

— проведение технологической проработки Подготовки производства, в т. ч. определение номенклатуры специализированного технологического оборудования, средств испытаний и1 измерений, подлежащих разработ­ке, и объема работ по их изготовлению, выдачу ТЗ на их разработку;

%— расчетные и при необходимости экспериментальные работы, подтверждающие необходимость примене­
ния в разрабатываемом КИМП драгоценных металлов или сплавов’на их основе; а также правильность выбора
геометрических размеров деталей и толщины покрытий; • ♦

— выдачу предварительных заяво’к- на материалы и комплектующие изделия; . *

— оценку КИМП на технологичность и правильность выбора средств и методов контроля (испытаний, анали­за, измерений); ‘ * • * ‘ » . . " * ; .

— Сравнительную оценку рассматриваемых вариантов, метрологического обеспечения- разрабатываемого КИМП (возможности выбора методов’ и средств измерения). Сравнения проводят по показателям качества КИМП’ (назначения, надежности, технологичности, стандартизации и «унификации, экономическим, эстетическим’, эрго­номическим и др.). При этом следует учитывать конструктивные и эксплуатационные особенности разрабатывае­мого и существующих КИМП, тенденции и перспективы развития отечественной и зарубежной техники в данной области; _.

— разработку и обоснование решений по выполнению требований метрологического обеспечения; состав­ление программы метрологического обеспечения; *

ч — предварительное решение вопросов упаковки и транспортирования КИМП;

— проверку соответствия вариантов требованиям техники безопасности и производственной Санитарии;

— разработку и обоснование технических решении по унификации (разработка КИМП в качестве базового и его модификаций, перспективность применения в последующих разработках и др.);-

— оценку КИМП по показателям стандартизации и унификации;

— разработку и обоснование решений по условиям применения, эксплуатации, техническому обслуживанию .

и ремонту; … * — ♦ .’••’.

— разработку мероприятий по обеспечению режима секретности, и противодействию иностранным техни­
ческим разведкам; — ‘ •» ‘*".•*

‘ — оценку соответствия КИМП требованиям эргокЪмикй, технической эстетики. При необходимости, для уста­
новления эргономических, эстетических характеристик КИМП и для удобства сопоставления различных вариантов
прэтим характеристикам изготавливают макеты; . * .*’ . > ‘ ~ — — .*

— проведение патентных исследований, составление справки об использовании материалов латентногсг фонда; . • \ • • ь * . . •..’■"•.’""•,".•.

— составление протокола распределения’работ между V\A ОКР .и изготовителем изделий. Призер распреде­ления работ, выполняемых изготовителем на этапах ОКР с-одновременным, освоением производства,, приведен "в приложении И; • * * " * \ >•’ —

— подготовку предложений по разработке стандартов (пересмотр или внесение изменений в действующие-

стандарты); * . .*…•••*** • ‘ ‘

— составление перечня работ, которые следует провести на последующем этапе ОКР, в дополнение или
уточнение работ, предусмотренных ХЗ; . • —

— разработку ведомости документов Эскизного проекта ОКР (если разработка предусмотрена’ в ТЗ).
Примечания, " • ‘ ~

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

2 Конкретный объем (перечень и состав) работ при разработке ЗП, определенный ГИ ОКР по КИМП и заказчиком, при необходимости "указывают в ТЗ на OKR . • .

ГОСТРВ 15.205—2004

Приложение Д (рекомендуемое)

Перечень работ; выполняемых на этагге технического проекта

Д.1 При разработке технического проекта ОКР с учетом требований ГОСТ 2.120 выполняют работы, необхо­димые для обеспечения .предъявляемых к КИМП требований ТЗ и позволяющие получить полное представление о конструкций разрабатываемого КИМП, оценить’его соответствие требованиям" ТЗ, технологичность, степень сложности изготовления, способы упаковки, возможности транспортирования и монтажа на месте применения, . удобство эксплуатации, целесообразность и возможность ремонта и т. д,

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

— разработку конструктивных решений КИМП и специальных технологических процессов" его изготовления;

— необходимые расчеты и экспериментальные работы для проверки оптимальности принятых конструктив­но-технических решений; . — * -.- —

‘ — разработку необходимых принципиальных схем, схем соединений и др.;

— разработку и обоснование технических решений; обеспечивающих показатели надежности, установлен­ные ТЗ.и эскизным, проектом (если он разрабатывался);

— разработку документации на макеты^ их изготовление и испытание; • • " .

— определение состава отбраковочных испытаний и методов их, проведения для выявления в процессе
> ‘производстваскрытых дефектов-и потенциально ненадежных составных частей и элементов изделия с лримене-
. t нием в необходимых случаях методов и средств физико-технического анализа w неразрушающего контроля;

‘ — анализ конструкции КИМП на технологичность с учетом отзывов изготовителей опытного образца и серий­
ных изделий в части обеспечения технологичности в условиях данного конкретного производства, в т. ч. по исполь- "
зованию имеющегося у изготовителей оборудования, а также учета в данном проекте требований нормативной
документации, действующей у них; выявление необходимого для производства КИМП нового оборудования (обог
снование разработки или приобретения); разработку метрологического обеспечения (выбор методов и средств
измерений); v

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

— уточнение решений по выполнению требований метрологического обеспечения;

— окончательное оформление заявок на разработку и изготовление новых средств измерения и материа-‘ лов, применяемых в разрабатываемом КИМП;

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

— разработку методов измерений, если соответствующие методы не установлены НД, а также, при необходи­мости, разработку и изготовление средств измерений; *

— оценку возможности транспортирования, хранения, .а также монтажа КИМП на месте его применения;

— проверку соответствия принимаемых решений требованиям техники безопасности и производственной санитарии; **

— мероприятия по обеспечению заданного в ТЗ уровня стандартизации и унификации КИМП;

— уточнение технических решении по унификации (разработка КИМП в качестве базового и его модифика­ций, перспективность применения в последующих разработках и др.);

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

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

— оценку КИМП в отношении его соответствия требованиям эргономики, технической эстетики;-

— оценку эксплуатационных данных КИМП (взаимозаменяемости, удобства обслуживания, ремонтопригод-
‘ ности, устойчивости к воздействию внешней среды* возможности быстрого устранения отказов, контроля качества
‘работы КИМП; обеспеченности средствами контроля технического состояния и др.); • •

— разработку и обоснование решений по ж’йвучести (в т. ч. стойкости к воздействию оружия массового пора­жения) и безопасности эксплуатации*/-, *"’••. • .’

— составление перечня рабочих КД и ТД, подлежащих согласованию с ПЗ;.

; ., — составление графика подготовки производства КИМП для изготовления установочной серии (при выполне­нии ОКР •’с одновременным освоением производства);

— составление отчета о проведенных патентных исследованиях по ГОСТ Р 15.011;

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

*

ГОСТРВ 15.205—2004

— необходимые расчеты, в т. ч. подтверждающие технико-экономические показатели, установленные ТЗ;

— подготовку предложений по разработке стандартов (пересмотр или внесение изменении в действующие стандарты); в ‘ .

• ‘ т составление перечня работ, которые следует провести на этапе разработки рабочей КД, в дополнение
и (или) уточнение работ, предусмотренных ТЗ и ЭП; ‘ * • . .

— разработку ведомости документов технического проекта ОКР (если разработка предусмотрена, в ТЗ). .
.Примечания . ‘. ‘ . ■

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

2 Конкретный объем (перечень и- состав) работ при разработке ТП, определенный ГИ ОКР. по КИМП.и заказчиком, при необходимости указывают в ТЗ на "ОКР • * *

ПриложениеЕ (рекомендуемое)

Перечень работ, выполняемых, на этапе изготовления опытного образца КИМП
" и прЬведения предварительных испытаний

Работы, проводимые на данном этапе, в общем длучае включают: .

— подготовку’ производства р?\я изготовления* опытных образцов и КИМП промышленного производства (для ОКР с одновременным освоением производства), в т. ч., если предусмотрено в ТЗ, и для их изготовления’в военное время; • »

— изготовление/ в необходимых случаях, технологического оборудования, оснастки;

— изготовление опытных образцов;

— метрологическое обеспечение испытаний по ГОСТ РВ 8,570, в т. ч. изготовление средств испытаний и измерений," проведение аттестации методик выполнения измерений согласно ГОСТ Р 8.563;

— проведение предварительных испытаний опытных образцов;

— оценку производственных запасов и КТЗ; а. • .

— составление справки о соответствии опытных образцов КИМП ТЗ;
‘ — составление акта предварительных испытаний; в

— корректировку "рабочих КД и ХД по результатам изготовления и предварительных испытаний с присвое­нием документации лидеры «О»; •

— разработку и согласование с ПЗ каталожных описаний; * * ‘

— отработку рекомендаций по оптимальным’ условиям и режимам применения КИМП в изделии ВТ; ‘-.расчет показателей уровня унификации разработанного"КИМП;

— оценку производственной технологичности разработанного КИМП;

— разработку проекта КТУ (если это предусмотрено в ТЗ);

— расчет технико-экономических показателей разработанного КИМП по результатам изготовления и испы­
таний опытных образцов и ориентировочный расчет технико-экономических показателей для условий промыш­
ленного производства (для ОКР V одновременным освоением производства);

— составление НТО и информационной карты на выполняемую ОКР;
-разработку проекта справочного листа;

— разработку проекта программы работы государственной комиссии по приемке ОКР, проектаi
государственных испытаний и других документов, необходимых для предъявления ОКР к приеыче;

— проведение метрологическом экспертизы проекта программы’ государственных испытании;
-доработку опытного образца или изготовление новых опытных образцов по документацияj
Примечания . + *

1 По решению заказчика и ГИ ОКР по КИМП при достаточном обосновании.
актом обоснования, допускается опытные образцы на военное время на отдельныеI

‘ изготовленные — не испытывать. . ‘

2 При выполнении этапа при необходимости выполняют другие работы. *

3 Контрольный объем (перечень и состав) работ на этапе, определенный ГИ ОКР no ҐV*JT\ и заказчиком, принеобходимости указывают в ТЗ на ОКР .


⇐ Предыдущая14151617181920212223Следующая ⇒


Дата публикования: 2014-11-18; Прочитано: 473 | Нарушение авторского права страницы



studopedia.org — Студопедия.Орг — 2014-2018 год.(0.01 с)…

ГОСТ 19.101-77 Виды программ и программных документов

ГОСТ 19.101-77 Виды программ и программных документов

УДК 002:651.7/.78:006.354

Группа Т55

 

Г О С У Д А Р С Т В Е Н Н Ы Й   С Т А Н Д А Р Т   С О Ю З А   С С Р


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

ГОСТ 19.101-77

(СТ СЭВ 1626-79)

 

ВИДЫ ПРОГРАММ И ПРОГРАММНЫХ ДОКУМЕНТОВ

 

United system for program documentation.
Types of programs and program documents


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

с 01.01 1980 г.

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

Стандарт полностью соответствует СТ СЭВ 1626-79.

1. ВИДЫ ПРОГРАММ

1.1. Программу (по ГОСТ 19781-90) допускается идентифицировать и применять самостоятельно и (или) в составе других программ.

1.2. Программы подразделяют на виды, приведенные в табл. 1

Таблица 1

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

 

1.3.

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

1.2,1.3. (Измененная редакция, Изм. № 1).

2. ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ

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

2.2.

Виды программных документов и их содержание приведены в табл. 2.

Таблица 2

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

 

(Измененная редакция, Изм. № 1).

2.3. Виды эксплуатационных документов и их содержание приведены табл.3.

Таблица 3

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

 

(Измененная редакция, Изм.

№ 1).

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

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

Таблица 4

 

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

2.2-2.5. (Измененная редакция, Изм. № 1).

2.6. Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра).

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

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

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

Технические условия разрабатывают на стадии «Рабочий проект».

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

(Введен дополнительно, Изм. № 1).


Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в июне 1981 г (ИУС 9-81)

Комплекс стандартов на автоматизированные системы (КСАС)

Содержание и сфера применения

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

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

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

Стандарты ЕСПД были приняты в конце 70-х годов и дошли до нас в виде, близком к первоначальному. В них отражена практика работы ведомственных вычислительных центров, где эксплуатировались большие ЭВМ. Взаимодействие человека с компьютерной системой тогда было построено совсем не так, как теперь, и осуществлялось через громоздкие пульты, перфокарты и распечатки, а для «простых смертных», решающих прикладные задачи, еще и при посредничестве квалифицированного персонала. Надо ли долго объяснять, насколько эти стандарты к настоящему времени устарели? Достаточно сказать, что им неведомы такие распространенные сегодня документы, как руководство пользователя и руководство администратора.

И все-таки ими продолжают активно пользоваться. Формально «девятнадцатому» есть современная альтернатива. Переведены на русский язык и приняты в России на правах национальных некоторые стандарты ИСО/МЭК в области системной и программной инженерии. Но крупные, в том числе, государственные заказчики переходить на них не торопятся. Это можно объяснить их косностью (или верностью традиции, как вам больше нравится), но лишь отчасти.

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

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

Состав нормативно-технических документов

Обозначение Наименование
ГОСТ 19.001-77 Единая система программной документации.
Общие положения
ГОСТ 19.002-80 Единая система программной документации.
Схемы алгоритмов и программ. Правила выполнения
ГОСТ 19.004-80 Единая система программной документации.
Термины и определения
ГОСТ 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.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 ЕСПД. Описание программы.

ГОСТ 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. Обеспечение систем обработки информации программное.

К другим стандартам в области документирования программных систем (ПС) относятся:

ГОСТ 34.602-89 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы.

ГОСТ 34.601-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированной системы. Стадии создания.

ГОСТ Р ИСО/МЭК ТО 12182-2002 Информационная технология. Классификация программных средств.

ГОСТ Р ИСО/МЭК 12207-99 Информационная технология. Процессы жизненного цикла программных средств.

ГОСТ Р ИСО/МЭК 14764-2002 Информационная технология. Сопровождение программных средств.

ГОСТ Р ИСО/МЭК 15026-2002 Информационная технология. Уровни целостности систем и программных средств.

ГОСТ Р ИСО/МЭК ТО 15271-2002 Информационная технология. Руководство по применению ГОСТ Р ИСО/МЭК 12207-99.

ГОСТ Р ИСО/МЭК 15910-2002 Информационная технология. Процесс создания документации пользователя программного средства.

Международные стандарты ISO/IEC:

ISO/IEC 12207:2008 System and software engineering – Software life cycle processes.

ISO/IEC 15288:2008 System and software engineering – System life cycle processes.

IEEE 830-1998 Recommended practice for software requirements specifications.

IEEE 1233-1998 Guide for developing system requirements specifications.

IEEE 1016-1998 Recommended Practice for Software Design Descriptions.

ISO/IEC 42010 IEEE Std 1471-2000 System and software engineering – Recommended practice for architectural description of software-intensive systems.

ISO 9001:2000 Quality management systems – Requirements.

ISO/IEC 90003:2004 Software engineering – Guidelines for the application of ISO 9001:2000 to computer software.

ISO/IEC TR 90005:2008 Software engineering – Guidelines for the application of ISO 9001:2000 to system life cycle processes.

ISO/IEC 9126-1:2001 Software engineering – Product quality – Part 1: Quality model.

ISO/IEC 9126-2:2003 Software engineering – Product quality – Part 2: External metrics.

ISO/IEC 9126-3:2003 Software engineering – Product quality – Part 3: Internal metrics.

ISO/IEC 9126-4:2004 Software engineering – Product quality – Part 4: Quality in use metrics.

ISO/IEC 25051:2006 Software engineering – Software product Quality Requirements and Evaluation (SQuaRE) – Requirements for quality of Commercial Off-The-Shelf (COTS) software product and instructions for testing.

IEEE 829-1998 Standard for Software Test Documentation.

IEEE 829-2008 Standard for Software and System Test Documentation.

IEEE 1008-1987 (R1993, R2002) Standard for Software Unit Testing.

ISO/IEC 14598-1:1999 Information technology – Software product evaluation – Part 1: General overview.

ISO/IEC 14598-2:2000 Software engineering – Product evaluation – Part 2: Planning and management.

ISO/IEC 14598-3:2000 Software engineering – Product evaluation – Part 3: Process for developers.

ISO/IEC 14598-4:1999 Software engineering – Product evaluation – Part 4: Process for acquirers.

ISO/IEC 14598-5:1998 Information technology – Software product evaluation – Part 5: Process for evaluators.

ISO/IEC 14598-6:2001 Software engineering – Product evaluation – Part 6: Documentation of evaluation modules.

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

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

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

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

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


123456Следующая ⇒


Дата публикования: 2015-04-06; Прочитано: 313 | Нарушение авторского права страницы



studopedia.org — Студопедия.Орг — 2014-2018 год.(0.002 с)…

Добавить комментарий

Закрыть меню