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

Каждый процесс ЖЦ ИС характеризуется определенными задачами и методами их решения, исходными данными, полученными на предыдущем этапе, и результатами. Результатами анализа, в частности, являются функциональные модели, информационные модели и соответствующие им диаграммы. На каждом этапе жизненного цикла порождается определенный набор технических решений и отражающих их документов, при этом для каждого этапа исходными являются документы и решения, принятые на предыдущем этапе. В процессе разработки ИС разрабатывается техническая документация на систему.

Термин «техническая документация» в различных источниках трактуется по-разному. Можно дать такое определение технической документации – это коммерческие документы, которые нужны при поставках оборудования и технических потребительских товаров длительного пользования. В документе Р 50-605-80-93 «Система разработки и постановки продукции на производство. Термины и определения» техдокументация представлена как совокупность документов, необходимая и достаточная для непосредственного использования на каждой стадии жизненного цикла продукции.

К технической документации относятся: конструкторская, технологическая документация, техническое задание на разработку продукции и т.д.

Техническую документацию можно подразделить на три категории:

1) Документация разработки. Документы описывают процесс разработки ИС, определяют требования, которым должна удовлетворять ИС, определяют проект ИС, определяют как его контролируют и как обеспечивают его качество. Документация разработки также включает в себя подробное описание ИС. Разработка документов преследует следующие цели:

· они являются средствами связи между всеми участникам и описывают подробные решения, принятых относительно требований к ИС, проекту, программированию, тестированию и т.д.;

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

· они выступают как контрольные пункты, которые позволяют руководству оценивать ход разработки;

· они образуют основу документации сопровождения ИС, как часть документации продукции;

· они описывают историю разработки ИС.

Документация разработки включает: исходную, проектную, рабочую, информационную документацию:

· к исходной относятся: заявка на разработку и освоение продукции, исходные требования, аванпроект, рекомендации по разработке продукции, выполняемые в процессе НИР, техническое задание.

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

· к рабочей документации - рабочая конструкторская, технологическая документация, эксплуатационная документация, ремонтная документация.

· к информационной документации - карта технического уровня и качества продукции, патентный формуляр, информационная карта расчета экономической эффективности и цен новой (модернизированной) продукции, каталоги, отчет о патентных исследованиях, экспертное заключение, акты и протоколы об испытаниях, решение о снятии продукции с производства и др. [из п. 1.6.1 Р 50-605-80-93].

2) Документация продукции. Эта документация обеспечивает информацию, необходимую для эксплуатации ИС (использования ИС в деятельности предприятия), а так же сопровождения, модернизации, преобразования и передачи проектной документации. Эта документация преследует следующие цели:

· обеспечение учебной и справочной информации для любого, использующего или эксплуатирующего ИС;

· облегчение сопровождения и модернизации ИС, специалистам, не разрабатывающим ИС;

· помощь при продаже или приемке ИС.

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

Если обратиться к ГОСТ Р ИСО 9127-94 Системы обработки информации. Документация пользователя……., то в нем вводится определение документации пользователя, как документации, которая обеспечивает пользователя информацией, необходимой для установки и прогона ПО и является обязательной в поставке (документация пользователя выполняется в виде одного или нескольких руководств и вкладывается вместе с программным продуктом внутрь упаковки). Данный стандарт определяет три категории информации:

· обязательная – информация, поставляемая с каждым пакетом;

· условная – информация, поставляемая с каждым пакетом. для которого она необходима;

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

Назначением документации пользователя является обеспечение конечного пользователя достаточной информацией для ясного понимания:

· целей, функций и характеристик ПО;

· того, как ввести в действие и использовать ПО;

· договорных прав и обязанностей.

3) Документация управления проектом. Документы создаются на основе информации управления проектом, такой как:

· графики для каждой стадии процесса разработки и отчеты об изменениях графика;

· отчеты о согласованных изменениях ИС;

· отчеты о решениях, связанных с разработкой ИС;

· распределение обязанностей.

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

Р 50-605-80-93 дает определение техдокументации на промышленную продукцию в целом. Для автоматизированных систем, являющихся частным случаем промышленной продукции, нормативно-технической документацией предусмотрены целых два определения:

«Комплект взаимоувязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС» [из п. 5.1 ГОСТ 34.003-90]

В ГОСТ 34.201-89 имеется иная трактовка, а именно:

Документация на автоматизированную систему - комплекс взаимоувязанных документов, в котором полностью описаны все решения по созданию и функционированию системы, а также документов, подтверждающих соответствие системы требованиям технического задания и готовность ее к эксплуатации (функционированию) [из п. 1 Приложения 1 ГОСТ 34.201-89].

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