Алгоритм разработки документации

 

Руководство по созданию документов

 

О чем это руководство?

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

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

Содержание

Какие сокращения используются?. 4

Предисловие. 5

1 Алгоритм разработки документации. 7

2 Краткий обзор ключевых документов. 10

2.1  Отчет о научно-исследовательской работе. 10

2.2  Техническое задание и Частное техническое задание. 10

2.3  Техническое предложение. 11

2.4  Пояснительная записка к техническому проекту. 11

2.5  Руководство пользователя и Руководство администратора. 12

2.6  Программа и методика испытаний. 12

2.6.1 Программа и методика предварительных/приемочных испытаний 13

2.6.2 Программа опытной эксплуатации. 14

3 Как связаны ключевые документы?. 15

4 Чек-лист по стилю и содержанию.. 16

5 Чек-лист по предпечатной подготовке. 20

6 Полезные ссылки. 22

 

Какие сокращения используются?

АС	Автоматизированная система
ГОСТ	Государственный стандарт
ПЗ	Пояснительная записка
ПМИ	Программа и методика испытаний
ПО	Программное обеспечение
РА	Руководство администратора
РД	Руководящий документ по стандартизации
РП	Руководство пользователя
ТЗ	Техническое задание
ТП	Техническое предложение
ЧТЗ	Частное техническое задание

 

Предисловие

Документация является неотъемлемой частью автоматизированных систем, разрабатываемых Компанией для государственных заказчиков, и призвана описыватьтребования к АС итехнические решения, содержать инструкции для пользователей и многое другое. В качестве нормативных документов, на основе которых выстроен процесс создания и оформления документов в Компании, используется комплекс стандартов на автоматизированные системы (ГОСТ 34), который включает 5 стандартов и руководящий документ по стандартизации:

- ГОСТ 34.003-90 Термины и определения;

- ГОСТ 34.201-89 Виды, комплектность и обозначение документов при создании автоматизированных систем;

- ГОСТ 34.601-90 Автоматизированные системы. Стадии создания;

- ГОСТ 34.602-89 Техническое задание на создание автоматизированной системы;

- ГОСТ 34.603-92 Виды испытаний автоматизированных систем;

- РД 50-34.698-90 Автоматизированные системы. Требования к содержанию документов (отменен Приказом Росстандарта № 216 от 12.02.2019, но может использоваться для справки).

Комплекс стандартов дает общее представление о стадиях создания АС, документации на каждой стадии, структуре и содержании документов и при этом не обязывает следовать положениям ГОСТов досконально. Именно поэтому ГОСТ 34, которому около 30 лет, до сих пор широко используется при создании АС.

ГОСТ Р 2.105-2019«Единая система конструкторской документации.Общие требования к текстовым документам» применяется при оформлении документов. Его положения частично легли в основу Инструкции по подготовке технической документации (И-27), разработанной нашей Компанией.

Перечисленные стандарты, И-27и данное руководство представляют собой нормативный минимум, рекомендованный для изучения перед началом разработки технической документации в Компании.

1 Алгоритм разработки документации

1. В календарном плане ТЗ определяются комплект и содержание документов на каждой стадии разработки АС.

2. Подготавливается документация согласно календарному плану ТЗ.

ГОСТ 34 предлагает 8 стадий создания АС и различные документы для каждой из них. На практике количество стадий и документов корректируется до объема, необходимого в рамках конкретного проекта.

В таблице нижеприведена следующая информация:

- стадии по ГОСТ 34.601-90 и для сравнения примеры стадий, которые могут быть выделены при создании АС на практике;

- результаты работ на каждой стадии;

- ключевыедокументы, разрабатываемыеКомпанией на каждой стадии. Полный перечень документов приведен в ГОСТ 34.201-89.

№	Стадии по ГОСТ 34.601-90	Примеры стадийсоздания АС в Компании	Результаты работ	Ключевая документация
	Формирование требований к АС	Обследование объекта автоматизации	Цели автоматизации	Отчет о научно-исследовательской работе
	Разработка концепции АС		Методы автоматизации
	Техническое задание	Предварительное проектирование	Постановка задачи	Техническое задание, Частное техническое задание
	Эскизный проект	Техническое проектирование	Технические решения	Пояснительная записка, Архитектура системы*, Описание информационного обеспечения системы, Описание комплекса технических средств, Описание программного обеспечения и др.
	Технический проект
	Рабочая документация	Рабочее проектирование	Готовность к развертыванию	Руководство пользователя, Руководство администратора, Технологическая инструкция, Каталог базы данных, Общее описание системы, Программа и методика испытаний (компонентов, комплексов средств автоматизации, подсистемы, систем) и др.
	Ввод в действие	Проведение испытаний (предварительных, опытной эксплуатации, приемочных)	Развернутая АС	Акты, протоколы проведения испытаний и пусконаладочных работ
	Сопровождение АС	Сопровождение АС	Функционирование АС, внесение изменений в документацию на АС	Отчеты об обслуживании и сопровождении АС
* В ГОСТ 34.201-89 не обозначен