Основные принципы разработки документации
3.1 Представленный в данном документе порядок документирования охватывает этапы жизненного цикла системы от формирования концепции до внедрения и сопровождения.
В таблицах 3 и 4 приведен основной состав документов, которые предназначены для использования при создании, применении и сопровождении информационных системы, в том числе для определения, управления и совершенствования сложных комплексов программ. При разработке документов возможна их адаптация в соответствии с характеристиками проектов. Адаптация является процессом исключения компонентов документов, не применяемых в конкретном проекте. Добавление уникальных или специфических документов должно быть оговорено в соответствующем договоре и (или) техническом задании.
3.2 Стороны - участники проекта ответственны за выбор модели комплекта документации для конкретного проекта и за адаптацию приведенных в данном ОРММ документов. Стороны также ответственны за выбор и применение методов и инструментальных средств автоматизации разработки программного обеспечения.
3.3 При создании и применении больших систем и обеспечении их жизненного цикла документами целесообразно применять выборку из всей совокупности стандартов, детализирующих частные процессы, работы и документы. Поэтому рекомендуется на начальном этапе проектирования таких систем (в техническом задании) сформировать возможный комплект документов (или первичный профиль), обеспечивающий регламентирование всех этапов, работ и документов.
Порядок разработки и комплектования документации
3.4.1 Документация разрабатывается как на АС в целом, так и на отдельные функциональные части (задачи) и компоненты. Наименование конкретных документов на АС в целом или ее части (комплекс задач, автоматизированное рабочее место, задачу
и пр.) определено ГОСТ 34.201, на комплексы программ (программы) - ГОСТ 19.101.
3.4.2 В зависимости от специфики создаваемых АС и применяемых методов проектирования допускается разрабатывать групповые и базовые документы, выпускать документы отдельными самостоятельными частями, расширять номенклатуру документов, установленную стандартами и данным ОРММ ИСЖТ.
3.4.3 Компоненты АС могут быть частью системы или иметь самостоятельное применение. Документация для компонентов АС разрабатывается в соответствии с приведенными в таблице 2 системами Государственных стандартов.
Таблица 2 - Используемые системы ГОСТ для разработки компонентов
Системы
| Наименование компонентов | Система ГОСТ |
| Программные средства и программные изделия | ЕСПД |
| Информационные средства и информационные изделия | КС АС, ЕСКД |
| Программно-технические комплексы | КС АС, ЕСПД |
| Автоматизированные рабочие места в АС | КС АС, ЕСПД |
| Автоматизированные рабочие места автономные | ЕСПД |
| Аппаратно-программные комплексы | ЕСКД, ЕСПД, КС АС |
| Банки данных и базы данных в АС | КС АС, ЕСПД |
| Технические средства в АС | ЕСКД, КС АС, ЕСПД |
3.4.4 Допускается выпуск проектной документации в соответствии с международными и национальными стандартами (в том числе ГОСТ Р ИСО/МЭК ТО 9294-93, ИСО 6592:1986 и др.), в первую очередь, при разработке систем с помощью закупленных CASE-средств, что должно быть указано в техническом задании.
3.4.5 В случае применения закупленных CASE-средств в техническом задании на систему при описании методологии, технологии и инструментального средства проектирования (CASE-средств) устанавливают требования к оформлению документации:
- комплектность, состав и структура на каждой стадии проектирования;
- требования к оформлению (включая требования к разделам документов) или ссылки на нормативные документы;
- требования к издательской системе, используемой в качестве встроенного средства подготовки документации;
- требования к настройке CASE-средств для обеспечения подготовки документации в соответствии с установленными правилами.
Допускается в документах, подготавливаемых с помощью CASE-средств, употребление английских слов в заголовках автоматически формируемых отчетов и диагностических сообщений. В этом случае в приложениях к документам должны быть приведены переводы типовых текстов.
3.4.6 Общий перечень документов, который используется при проектировании системы в целом и ее частей, приведен в таблице 3. Документация на АС, ее части и компоненты подразделяется на:
- документацию процесса разработки, включающую подробные технические описания и подготавливаемую для специалистов, ведущих проектирование, разработку и сопровождение информационных систем, обеспечивающую возможность отчуждения, детального освоения, развития и корректировки ими программ, баз данных и технологических процессов на всем жизненном цикле системы;
- эксплуатационную документацию (ЭД) - документацию продукции, создаваемую для конечных пользователей системы и позволяющую им осваивать и эксплуатировать ее для решения конкретных функциональных задач.
3.4.7 Документация разработки АС и ее частей содержит согласно ГОСТ 34.201 следующие части проекта (таблица 3):
- общесистемные решения (ОР);
- решения по организационному обеспечению (ОО);
- решения по техническому обеспечению (ТО);
- решения по информационному обеспечению (ИО);
- решения по программному обеспечению (ПО);
- решения по математическому обеспечению (МО).
Приведенные части проекта являются разделами "Ведомости технического проекта", "Ведомости рабочей документации" или "Ведомости технорабочего проекта".
3.4.8 Эксплуатационная документация (ЭД), отмеченная в таблице 3 знаком "Х", включает документы, предназначенные для:
- пользователей, которые эксплуатируют АС и ее компоненты;
- общую информацию, описывающую АС и ее компоненты для всех заинтересованных лиц.
Таблица 3 - Перечень документов, который используется при