Основу отечественной нормативной
базы в области документирования ПС составляет комплекс стандартов Единой
системы программной документации (ЕСПД). Основная и большая часть комплекса
ЕСПД была разработана в 70-е и 80-е годы. Стандарты ЕСПД в основном охватывают
ту часть документации, которая создается в процессе разработки ПС, и связаны,
по большей части, с документированием функциональных характеристик ПС.
Согласно ЕСПД программный документ –
это документ, содержащий сведения, необходимые для разработки, изготовления,
эксплуатации и сопровождения программного изделия. Номенклатуру программных
документов определяет
ГОСТ 19.101-77 «ЕСПД. Виды программ и программных документов».
В качестве основных видов программ
стандартом определяются:
§ компоненты – программы, рассматриваемые как единое целое, выполняющие законченную функцию и применяемые
самостоятельно или в составе комплекса;
§ комплексы – программы, состоящие из двух или более компонентов, выполняющие взаимосвязанные функции и
применяемые самостоятельно или в составе другого комплекса.
Виды программных документов и их
краткое содержание представлены в стандарте описаниями, приведенными в таблице
1.
Таблица 1. Виды программных
документов
|
Вид |
Содержание документа |
|
|
|
|||
|
документа |
|
|
|
|
|
|
|
|
Спецификация |
Состав программы и документация на ее |
|
|||||
|
|
|
|
|
|
|
|
|
|
Ведомость |
Перечень предприятий, на которых
хранятся |
||||||
|
держателей |
подлинники программных документов |
|
|||||
|
подлинников |
|
|
|
|
|
|
|
|
Текст |
Запись рограммы с необходимыми
|
|
с |
|
|||
|
программы |
комментариями |
|
|
|
|
||
|
Описание |
Сведения о логической структуре |
|
|||||
|
программы |
и функционировании программы |
|
|||||
|
Программа и |
Требования, подлежащие
проверке при |
||||||
|
методика |
испытании программы, а также порядок |
|
|||||
|
испытаний |
и методы их контроля |
|
|
|
|||
|
Техническое |
Назначение и
область применения программы; |
||||||
|
задание |
технические, технико-экономические
и |
|
|
||||
|
|
специальные требования, предъявляемые к |
||||||
|
|
программе; необходимые
стадии и сроки |
||||||
|
|
разработки; виды испытаний |
|
|
||||
|
Пояснительна |
Схема алгоритма, общее описание
алгоритма |
||||||
|
я записка |
и (или) функционирования программы,
а |
||||||
|
|
также обоснование принятых
технических и |
||||||
|
|
технико-экономических решений |
|
|||||
|
Эксплуатацио |
Сведе ния для обеспечения |
|
|
|
|
||
|
нные |
функционирования и эксплуатации |
|
|
||||
|
документы |
программы |
|
|
|
|
||
Перечень эксплуатационных
документов, рекомендуемых ЕСПД, представлен в табл. 2.
Таблица 2. Виды эксплуатационных
документов
|
ид документа |
Содержание документа |
|||||||||
|
Ведомость |
Перечень эксплуатационных
документов |
|||||||||
|
эксплуатационных |
на программу |
|||||||||
|
документов |
|
|||||||||
|
Формуляр |
|
Основные |
характеристики |
программы, |
||||||
|
|
|
комплектность |
и |
сведения |
об |
|||||
|
|
|
эксплуатации программы |
|
|
||||||
|
Описание |
|
Сведения о
назначении программы, |
||||||||
|
применения |
|
области |
применения, |
|
применяемых |
|||||
|
|
|
методах, классе
решаемых задач, |
||||||||
|
|
|
ограничениях |
для |
|
применения, |
|||||
|
|
|
минимальной конфигурации
технических |
||||||||
|
|
|
средств |
|
|
|
|
|
|||
|
Руководство |
|
Сведения для
проверки, обеспечения |
||||||||
|
системного |
|
функционирования |
и |
настройки |
||||||
|
программиста |
|
программы |
на |
условия |
конкретного |
|||||
|
|
|
применения |
|
|
|
|
||||
|
Руководство |
|
Сведения для эксплуатации
программы |
||||||||
|
программиста |
|
|
|
|
|
|
|
|||
|
Руководство |
|
Сведения |
для
обеспечения процедуры |
|||||||
|
оператора |
|
общения
оператора с |
вычислительной |
|||||||
|
(пользователя) |
|
системой |
в |
процессе |
выполнения |
|||||
|
|
|
программы |
|
|
|
|
|
|||
|
Описание языка |
|
Описание синтаксиса и семантики
языка |
||||||||
|
Руководство |
по |
Сведения для
применения тестовых и |
||||||||
|
техническому |
|
диагностических |
программ |
при |
||||||
|
обслуживанию |
|
обслуживании технических средств |
|
|||||||
Допускается объединение отдельных
видов эксплуатационных документов (за исключением ведомости эксплуатационных
документов и формуляра), необходимость объединения указывается в техническом
задании. Объединенному документу присваивают наименование и обозначение одного
из объединяемых документов. В объединенных документах должны быть приведены
сведения, которые необходимо включать в каждый объединяемый документ.
ГОСТ 19.701-90 (ИСО 5807-85)
"Единая система программной документации. Схемы алгоритмов, программ, данных
и систем. Обозначения условные и правила выполнения". Стандарт распространяется на условные
обозначения (символы) в схемах алгоритмов, программ, данных и систем и
устанавливает правила выполнения схем, используемых для отображения различных
видов задач обработки данных и средств их решения.
В
РФ
действует ряд стандартов в части документирования ПС, разработанных на основе
прямого применения международных стандартов ИСО.
ГОСТ Р ИСО/МЭК 9294-93
«Информационнаятехнология. Руководство по управлению документированием
программного обеспечения». Стандарт
устанавливает рекомендации по эффективному управлению документированием ПС
для руководителей, отвечающих за их создание. Целью стандарта является оказание
помощи в определении стратегии документирования ПС; выборе стандартов по
документированию; выборе процедур документирования; определении необходимых
ресурсов; составлении планов документирования.
ГОСТ Р ИСО 9127-94 «Системы
обработки информации. Документация пользователя и информация на упаковке для
потребительских программных пакетов». В контексте настоящего стандарта под потребительским
программным пакетом (ПП) понимается «программная продукция, спроектированная и
продаваемая для выполнения определенных функций; программа и соответствующая ей
документация, упакованные для продажи как единое целое». Под документацией
пользователя понимается документация, которая обеспечивает конечного
пользователя информацией по установке и эксплуатации ПП. Под информацией на
упаковке понимают информацию, воспроизводимую на внешней упаковке ПП. Ее целью
является предоставление потенциальным покупателям первичных сведений о ПП.
Содержание документа
"Руководство пользователя" Документ "Руководство пользователя",
разрабатывается на основании методических указаний РД 50-34.698-90. Данный
документ формируется IT-специалистом, или функциональным специалистом, или
техническим писателем в ходе разработки рабочей документации на систему и её
части на стадии «Рабочая документация».