Оглавление секции
-
Документирование ИС тесно связано с производством самого программного продукта и частично определяется стандартами ГОСТ 34.601-90 (стадии создания АС), ГОСТ 19.10177 (перечень документов) и ГОСТ Р ИСО/МЭК 15910-2002 (стадии создания документации пользователя АС). Попробуем создать общую схему технологии документирования, основанную на практическом опыте автора.
Существует два варианта создания ИС:
1) Система создается по заказу (договор на продукт или услугу). При этом возникают деловые отношения, которые регулируются законодательством (между Разработчиком и Заказчиком). Уровень документирования должен быть высоким, пакет документации – максимально полным по ГОСТ 34.601-90 и 34.602-89. Схема документирования первого варианта представлена на рисунке.
Пакет документации (стандартно) включает:
- Отчет об обследовании;
- Технико-экономическое обоснование;
- Пояснительная записка;
- Техническое задание;
- Описание системы (программы);
- Описание применения системы;
- Программа и методика испытаний;
- Формуляр;
- Паспорт программы (системы);
- Ведомость эксплуатационных документов;
- Руководство пользователя;
- Руководство администратора;
- Руководство по техническому обслуживанию.
2) Система создается для собственных нужд организации (Потребитель).
Уровень документирования может быть низким, пакет документации ограничивается руководствами пользователя и администратора. Но если система в дальнейшем будет предлагаться сторонним организациям как товар, возникают деловые отношения аналогично пункту 1 и уровень документирования должен быть повышен до среднего с минимальным пакетом документации. Поэтому автор советует сразу готовить подобный пакет документации, определяемый ГОСТ 19.101-77. Схема упрощенного документирования представлена на рисунке
Пакет документации (минимальный) включает: - Описание системы (программы); - Руководство пользователя; - Руководство администратора; - Руководство по техническому обслуживанию.
3.1. Подготовительный этапПодготовительный этап обычно включает в себя несколько действий, которые обычно не описываются в стандартах:1) Встреча и обсуждение с Заказчиком условий разработки ИС (или приобретения готового продукта);2) Обследование представителями Разработчика организации Заказчика на предмет выявления основных условий и требований к разработке (внедрению) ИС;3) Разработка черновиков пояснительной записки (ПЗ), технико-экономического обоснования (ТЭО). При необходимости – служебные записки (СЗ) подразделениям Разработчика и Заказчика для сбора необходимых сведений;4) После принятия руководством Заказчика и Разработчика решения о разработке (покупке) ИС ТП следует ознакомиться с официальными документами, подтверждающими это решение (протоколы, СЗ и т.п.);5) После подписания Договора на разработку (покупку) ИС ТП должен получить его копию с обязательным приложением - технической спецификацией (ТС). Обследование организации Заказчика должно проводиться тщательно и ТП может принимать в нем участие (наряду с техническими специалистами, программистами и экономистами Разработчика), чтобы выявить те основные положения, которые лягут в основу функционала ИС. Сведения, которые собираются во время обследования, станут основой пояснительной записки и ТЭО, черновики которых позволят очертить круг проблем и задач, имеющихся в организации Заказчика и которые можно решить путем создания новой или внедрения готовой ИС. Среди собираемых сведений могут быть: Сведения об организации: Наименование, адрес, контакты; Структура, подчиненность, деятельность, процессы, информационно-коммуникационная инфраструктура и т.п.Материалы, которые будут получены при обследовании, войдут на последующих этапах в техническую спецификацию (приложение к договору на создание или внедрение ИС), техническое задание и часть программных документов, которые будут готовиться в процессе разработки и внедрения ИС. Чем больше будет собрано материалов, тем легче ТП будет создавать пакет документации по ИС, а разработчикам будет проще согласовывать разработанные части системы с Заказчиком на основании заранее собранных документированных требований и ограничений по назначению и функционалу системы.Собранные во время обследования сведения могут быть использованы ТП для разработки черновиков двух документов, которые способны оказать определенное влияние на Заказчика и команду разработчиков: пояснительная записка (ПЗ) и техникоэкономическое обоснование (ТЭО). Состав и качество этих документов имеет значение для последующих работ, поэтому ТП должен относиться к их составлению с высокой ответственностью и привлекать к работе всех заинтересованных лиц. Разработчики (руководитель проекта, системный архитектор и руководитель программистов) могут дополнить начальный вариант ПЗ и ТЭО, внести четкие определения по средствам, срокам и ресурсам. Заказчик, ознакомившись с ПЗ и ТЭО, также может внести свои правки, получив конкретную информацию по способам и срокам реализации новой системы. Черновик ПЗ создается на основе ГОСТ 19.404-79 и собранных у Заказчика сведений (технического, экономического и организационного характера). Черновик ТЭО создается в произвольной форме, но имеет смысл использовать структуру, близкую к структуре ПЗ, только с экономическим уклоном. Также можно воспользоваться устаревшим стандартом ГОСТ 24.2020-80 «ЕСС АСУ. Требования к содержанию документа «Технико-экономическое обоснование создания АСУ»», который содержит следующую структуру документа: Введение- основание для проведения работ;- наименование организации-заказчика;- наименование организаций-участников работ;- сроки начала и окончания работ;- источники, объемы, порядок финансирования работ;- перечень нормативно-технических документов,Раздел 1. Характеристика объекта и существующей системы управления- общую характеристику объекта;- характеристику производственно-хозяйственной деятельности, организационной и производственной структуры объекта;- характеристику существующей системы управления, ее структурных элементов с указанием распределения функций управления между элементами организационной структуры;- характеристику функций управления, используемых методов и средств управления;- перечень и характеристику недостатков в организации и управлении объектом (в методах управления, организационной структуре управления, выполнении функций управления, обеспечении информацией и т.д.);- оценку производственных потерь, возникающих из-за недостатков в организации и управлении по объекту в целом и его частям (ухудшение технико-экономических и социальных показателей деятельности объекта и его частей);- характеристику готовности объекта к созданию АСУ.Раздел 2. Цели, критерии и ограничения создания АСУ- формулировку производственно-хозяйственных, научно-технических и экономических целей и критериев создания АСУ;- характеристику ограничений по созданию АСУ.Раздел 3. Функции и задачи создаваемой АСУ- обоснование выбора перечня автоматизированных функций и комплексов задач (задач) управления с указанием очередности внедрения;- требования к характеристикам реализации функций и задач управления в соответствии с действующими нормативно-техническими документами, определяющими общие технические требования к АСУ конкретного вида;- дополнительные требования к АСУ в целом и ее частям, учитывающие специфику объекта управления и создаваемой АСУ.Раздел 4. Ожидаемые технико-экономические результаты создания АСУ- перечень основных источников экономической эффективности получаемых в результате создания АСУ (в том числе — экономия производственных ресурсов, улучшение качества продукции, повышение производительности труда и т. д.) и оценку ожидаемых изменений основных технико-экономических и социальных показателей производственно-хозяйственной деятельности объекта (например показателей по номенклатуре и объемам производства, себестоимости продукции, рентабельности, отчислениям в фонды экономического стимулирования, уровню социального развития);- оценку ожидаемых затрат на создание АСУ с распределением их по очередям создания АСУ по годам;- ожидаемые обобщающие показатели экономической эффективности АСУ.Раздел 5. Выводы и предложения- выводы о производственно-хозяйственной необходимости и технико-экономической целесообразности создания АСУ;- предложения по совершенствованию организации и управления;- рекомендации по созданию АСУ.