ТЕМА 5. Технологии внедрения информационных систем Лекция 19. Разработка проектной и эксплуатационной документации на ИС.

2 Разработка эксплуатационной документации на ИС Документация на ИС включает: документацию на ПО; документацию на ТС; документацию для персонала. Документация на ПО: руководство пользователя, руководство системного администратора руководство программиста. Задача технологической инструкции – соотнести функциональность ПО автоматизированной системы с практикой, описать работу пользователей ИС по существу.

3 Причины разделения технологической инструкции и руководства пользователя Одни и те же функции ПО могут использоваться разными сотрудниками при выполнении разных операций Процессы сопровождения ПО и реинжиниринга организационной структуры могут протекать по-разному. Объединение программной и организационной части в одном документе осложнит его обновление и согласование Текст инструкции, предназначенной для пользователя, будет перегружен техническими деталями, осложняющими общее понимание технологической операции.

4 Технологическая инструкция Технологическая инструкция – сборник описаний технологических операций. Технологическая операция (в проектировании) – основная единица работы, выполняемая определенной ролью, которая: подразумевает четко определенную ответственность роли; дает четко определенный результат (набор рабочих продуктов), базирующийся на определенных исходных данных; представляет собой единицу работы с жестко определенными границами, которые устанавливаются при планировании проекта. Технологическая операция (в бизнес-процессе пользователя) – связное действие, выполняемое одним субъектом в течение ограниченного времени и приводящее к осмысленному результату безотносительно средств его достижения.

5 Элементы технологической инструкции Триггер – событие или обстоятельство, при наступлении которого пользователь выполняет операцию. Результат операции – существенное изменение ситуации, которое происходит после ее успешного выполнения. Результат не следует путать с выходными данными или документами. Пошаговое описание выполнения операции, подробность и объем которого во многом определяются особенностями АС. Способ проверки успешности выполнения операции. Описание нештатных ситуаций и возможных действий в них.

6 Нормативные документы, регламентирующие процесс документирования ГОСТ Р ИСО/МЭК «Информационная технология. Процессы жизненного цикла программных средств» ГОСТ Р ИСО/МЭК ТО «Информационная технология. Руководство по управлению документированием программного обеспечения» ГОСТ Р ИСО/МЭК « Информационная технология. Процесс создания документации пользователя программного средства»

7 Разработка эксплуатационной документации

8 Содержание плана документирования рабочее наименование, назначение, область применения и ограничения по использованию; спецификация стиля; определение аудитории пользователей; содержание документации с оценкой ее постраничного объема; номенклатура поставки; установление собственника авторских прав на документацию; обеспечение перевода документации на другие языки уровни (грифы) секретности и конфиденциальности (при необходимости); процедуры и проверки, могущие влиять на процесс разработки документации; методы и средства производства и используемые версии данных средств; структура коллектива разработчиков документации; взаимосвязи (подчиненности) проекта; почасовая загрузка и зарплата персонала; требования к проектным ресурсам, включая информационные и прочие ресурсы, представляемые заказчиком, и срокам их представления; метод передачи документатору информации об изменениях программного средства в процессе его разработки; планы контроля изменений и сопровождения документации; планы проверки документации после ее создания; календарное планирование по контрольным точкам.

9 Методы оценки трудоемкости разработки ТД ГОСТ Р ИСО/МЭК « Информационная технология. Процесс создания документации пользователя программного средства» Метод нисходящего проектирования Поминутно-почасовой метод Метод оценки трудоемкости разработки технической документации по аналогии с методом оценки трудоемкости разработки ПО (метод функциональных точек).

10 Метод нисходящего проектирования Разделить документацию на части Оценить объем каждой части в страницах При планировании работ исходить из нормативов выпуска технической документации. автор может за месяц подготовить 22 страницы нового текста; автор может за месяц подготовить 44 страницы текста с изменениями.

11 Метод нисходящего проектирования 15 % - планирование: 1) 1) исследование и подготовка плана; 2) 2) изучение и проверка плана; 3) 3) корректировка плана по результатам проверки. 50 % - написание первой редакции: 1) 1) подготовка содержания документации; 2) 2) изучение и проверка содержания; 3) 3) подготовка пробного куска текста для редактора; 4) 4) редактирование пробного куска текста и его переписывание по замечаниям редактора; 5) 5) написание всей первой редакции документации; 6) 6) редактирование всей первой редакции документации; 7) 7) переработка отредактированной документации; 8) 8) изучение и проверка переработанной документации.

12 Метод нисходящего проектирования 25 % - написание второй редакции: 1) 1) внесение в документацию всех изменений, предложенных по результатам проверки первой редакции; 2) 2) повторное редактирование второй редакции документации; 3) 3) переработка отредактированной документации; 4) 4) изучение и проверка переработанной документации. 10 % - подготовка фотошаблонов (скриншотов): 1) внесение в документацию всех изменений, предложенных по результатам проверки второй редакции; 2) проверка правильности внесения данных изменений; 3) удаление всех редакционных разметок; 4) изготовление фотошаблонов; 5) отправку фотошаблонов в печать (в типографию).

13 Поминутно-почасовой метод 1)Определение номенклатуры поставки 2)Исследование содержания документации 3)Написание плана документирования 4)Проектирование структуры документа и правил оформления его страниц 5)Написание первой редакции (документации) 6)Разработка графических материалов 7)Объединение текстовых и графических материалов 8)Проверка первой редакции (эксперт) 9)Корректировка первой редакции и графики 10)Внесение замечаний пользователя 11)Грамматическое редактирование 12)Подготовка второй редакции (документации) 13)Проверка второй редакции (эксперт) 14)Окончательная корректировка документации 15)Нормоконтроль документации 16)Изготовление фотошаблонов 17)Печать и переплетение оригиналов 18)Печать и брошюровка копий 19)Рассылка 16 ч на проект 24 ч на проект 48 ч на проект 8 ч на том 1 ч на страницу 5 ч на материал 30 мин на страницу 15 мин на страницу 10 мин на страницу 15 мин на страницу 3 сут. 5 сут. 10 сут. 1 сут.

14 Метрики документирования Метрики проекта Метрики пользовательской перспективы Метрики данных Метрики интерфейса пользователя Объем доступной документации; Количество экспертов Количество рецензентов Количество функциональных ролей; Количество пользовательских задач; Количество функций программы; Количество реакций пользователя на сообщения программы Количество сущностей; Количество атрибутов объектов; Количество поддерживаемых форматов данных Количество главных окон и рабочих областей; Количество крупных экранных форм; Количество команд главного меню; Количество сообщений об ошибках

15 Последовательность разработки эксплуатационной документации Изучение продукта Чтение документации; Интервью; Работа на стенде Составление плана документирования Анализ требований к документу; Составление структуры документа; Составление и согласование плана документирования Написание текста Изложение структурной информации; Изложение процедурной информации; Изложение справочной информации; Подготовка рисунков Согласование текста Обсуждение замечаний; Внесение исправлений Оформление текста Авторская разметка; Расстановка перекрестных ссылок; Разметка указателя

16 Для решаемой задачи измеряются значения каждого показателя из списка метрик. Для каждого вида работ рассчитывается трудоемкость по формуле: Трудоемкость i = Метрика 1 *T i1 + Метрика 2 *T i2 +…+ Метрика N *T iN.

17 Средства автоматизированного документирования Technical Guide Builder WackoWiki AuthorIT Adobe FrameMaker IBM Rational SoDA

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

19 Цели и задачи экспертизы ТД ЦЕЛИ: снижение финансовых рисков заказчика и исполнителя при создании ИС; сокращение сроков ввода ИС в действие. ЗАДАЧИ: проверка технической документации на комплектность; проверка структуры разделов технической документации на соответствие требованиям стандартов, нормативных документов и актов; проверка соответствия содержательной части технической документации требованиям НТД и техническим требованиям организации-эксперта.

20 Техническая документация, подлежащая экспертизе Техническое задание на создание автоматизированной системы; Технический или технорабочий проект; Документы, разрабатываемые на стадии «Рабочая документация»; Эксплуатационная документация; Программа и методики испытаний.

21 Взаимосвязь технической документации Техническое задание Пояснительная записка к техническому проекту Общее описание системы (рабочий проект) Требования Решения Стадия анализа предметной области Сведения о системе Проектная стадия Стадия реализации (разработки)

22 Техническое задание Пояснительная записка к ТП Общее описание системы перечень подсистем, их назначение и основные характеристики... решения по структуре системы, подсистем… сведения об АС в целом и ее частях... требования к характеристикам взаимосвязей системы со смежными системами, требования к ее совместимости решения по взаимосвязям АС со смежными системами, обеспечению ее совместимости описание взаимосвязей АС с другими системами требования к режимам функционирования системы решения по режимам функционирования описание функционирования системы

23

24 Оценка трудоемкости разработки ТЗ Справочник базовых цен на разработку технической документации на автоматизированные системы управления технологическими процессами (АСУТП) Разработчики: ЗАО «Научно-производственный центр «ВНИПИ САУ-40» ТП «ЦЕНТРИНВЕСТпроект» Минстроя России. Базовая цена разработки ТЗ определяется в зависимости от количества баллов ( Б), подсчитанных по основным факторам трудоемкости, соответствующего ценностного множителя (S) и общего поправочного коэффициента (K): Ц баз = S x Б x К

25 Факторы, определяющие трудоемкость разработки ТЗ Степень научно-технической новизны технологического объекта управления (ТОУ) (Ф1) Характер протекания управляемого технологического процесса во времени (Ф2) Количество технологических операций, выполняемых на ТОУ (Ф3) Количество переменных, характеризующих ТОУ (Ф4)

26 Степень научно-технической новизны ТОУ (Ф1) I степень: имеет аналоги в России – 1 балл I степень: имеет аналоги в России – 1 балл II степень: имеет аналоги только за рубежом – 2 балла II степень: имеет аналоги только за рубежом – 2 балла III степень: ни с конструкторской, ни с технологической точек зрения ТОУ не является принципиально новым объектом, но действующих аналогов не имеет – 4 балла III степень: ни с конструкторской, ни с технологической точек зрения ТОУ не является принципиально новым объектом, но действующих аналогов не имеет – 4 балла IV степень: принципиально новый объект – 8 баллов IV степень: принципиально новый объект – 8 баллов

27 Характер протекания управляемого технологического процесса во времени (Ф2) Непрерывный – 1 балл Непрерывный – 1 балл Полунепрерывный (непрерывный, с существенными для управления переходными режимами, вызванными добавками (заменами) сырья или реагентов либо выдачей продукции) – 2 балла Полунепрерывный (непрерывный, с существенными для управления переходными режимами, вызванными добавками (заменами) сырья или реагентов либо выдачей продукции) – 2 балла Непрерывно-дискретный, сочетающий непрерывные и прерывистые режимы на различных стадиях процесса – 4 балла Непрерывно-дискретный, сочетающий непрерывные и прерывистые режимы на различных стадиях процесса – 4 балла Непрерывно-дискретный, сочетающий непрерывные и прерывистые режимы с малой длительностью непрерывных режимов в аварийных условиях – 5 баллов Непрерывно-дискретный, сочетающий непрерывные и прерывистые режимы с малой длительностью непрерывных режимов в аварийных условиях – 5 баллов Циклический (прерывистый, с существенной для управления длительностью интервалов непрерывного функционирования и циклическим следованием интервалов с различными режимами) – 4 балла Циклический (прерывистый, с существенной для управления длительностью интервалов непрерывного функционирования и циклическим следованием интервалов с различными режимами) – 4 балла Дискретный (прерывистый, с малой, несущественной для управления длительностью непрерывных технологических операций) – 3 балла Дискретный (прерывистый, с малой, несущественной для управления длительностью непрерывных технологических операций) – 3 балла

28 Количество технологических операций, выполняемых на ТОУ (Ф3) до 5 – 1 балл до 5 – 1 балл от 5 до 10 – 2 балла от 5 до 10 – 2 балла от 10 до 20 – 4 балла от 10 до 20 – 4 балла от 20 до 35 – 5 баллов от 20 до 35 – 5 баллов от 35 до 50 – 7 баллов от 35 до 50 – 7 баллов от 50 до 70 – 9 баллов от 50 до 70 – 9 баллов от 70 до 100 – 10 баллов от 70 до 100 – 10 баллов за каждые 50 свыше 100 – 1 балл за каждые 50 свыше 100 – 1 балл

29 Количество переменных, характеризующих ТОУ (Ф4) До 20 – 1 балл До 20 – 1 балл от 20 до 50 – 2 балла от 20 до 50 – 2 балла от 50 до 100 – 3 балла от 50 до 100 – 3 балла от 100 до 170 – 4 балла от 100 до 170 – 4 балла от 170 до 250 – 5 баллов от 170 до 250 – 5 баллов от 250 до 350 – 6 баллов от 250 до 350 – 6 баллов от 350 до 470 – 7 баллов от 350 до 470 – 7 баллов от 470 до 600 – 8 баллов от 470 до 600 – 8 баллов от 600 до 800 – 9 баллов от 600 до 800 – 9 баллов от 800 до 1000 – 10 баллов от 800 до 1000 – 10 баллов от 1000 до 1300 – 11 баллов от 1000 до 1300 – 11 баллов от 1300 до 1600 – 12 баллов от 1300 до 1600 – 12 баллов от 1600 до 2000 – 13 баллов от 1600 до 2000 – 13 баллов за каждые 500 свыше 2000 – 1 балл за каждые 500 свыше 2000 – 1 балл

30 Поправочные коэффициенты Повышающие Понижающие Учет разработки АСУТП с целью тиражирования Учет разработки АСУТП с целью тиражирования Учет разработки нескольких вариантов построения системы Учет разработки нескольких вариантов построения системы Учет разработки АСУТП за рубежом Учет разработки АСУТП за рубежом Учет особых условий функционирования АСУТП Учет особых условий функционирования АСУТП Учет повторной применимости АСУТП Учет повторной применимости АСУТП Учет разработки ТЗ для перенастройки АСУТП при реконструировании объекта управления Учет разработки ТЗ для перенастройки АСУТП при реконструировании объекта управления

Пример определения базовой цены разработки ТЗ Исходные данные: Ф1 - II степень; Ф2 – полунепрерывный технологический процесс; Ф3 - 42; Ф ; создаваемая АСУТП является впервые разрабатываемой и подлежит эксплуатации в России; АСУТП разрабатывается с целью тиражирования; АСУТП создастся на вновь проектируемом ТОУ Значения коэффициентов: АСУТП создается с использованием зарубежных технических средств: К 6 = 1,2; АСУТП подлежит эксплуатации в условиях взрывоопасного производства: К 10.1 =1,2. 31

Пример определения базовой цены разработки ТЗ 3. Расчет базовой цены разработки ТЗ: а) определяется сумма баллов Б тз = =18 Б тз = =18 б) определяется цена разработки ТЗ S тз x Б тз = 18000*18= руб. в) определяется общий повышающий коэффициент К пв = 1+(0,2+0,2) = 1,4 г) с учетом коэффициентов базовая цена разработки составит *1,4 = руб. 32

Правила определения общих коэффициентов При определении базовой цены с применением нескольких коэффициентов, больших единицы, общий повышающий коэффициент определяется путем суммирования их дробных частей и единицы. При определении базовой цены с применением нескольких коэффициентов, больших единицы, общий повышающий коэффициент определяется путем суммирования их дробных частей и единицы. При определении базовой цены с применением нескольких коэффициентов, меньших единицы, общий понижающий коэффициент определяется путем их перемножения. При определении базовой цены с применением нескольких коэффициентов, меньших единицы, общий понижающий коэффициент определяется путем их перемножения. В случае применения одновременно повышающих и понижающих коэффициентов сначала в указанном порядке определяются общий повышающий и общий понижающий коэффициенты, которые затем перемножаются. В случае применения одновременно повышающих и понижающих коэффициентов сначала в указанном порядке определяются общий повышающий и общий понижающий коэффициенты, которые затем перемножаются. 33

34 Нормативы времени на разработку проекта ТЗ ГОСТ Р ИСО МЭК Процесс создания документации пользователя программного средства. ГОСТ Р ИСО МЭК Процесс создания документации пользователя программного средства. Нормативы времени определяются объемом (в листах ф. А4) и количеством показателей. Нормативы времени определяются объемом (в листах ф. А4) и количеством показателей. Показатели Показатели Объем До 10 Свыше 46 До 10 л. А4 20 ч. 46 ч. Свыше 26 л. А4 93 ч. 215 ч.

35 Нормоконтроль - 0,2 ч /лист ф. А4 Нормоконтроль - 0,2 ч /лист ф. А4 Квалификация – старший инженер. Технический контроль - 0,2 ч /лист ф. А4 Технический контроль - 0,2 ч /лист ф. А4 Квалификация – старший инженер. Выдача заключения сторонними организациями - 0,9 ч /лист ф. А4 Выдача заключения сторонними организациями - 0,9 ч /лист ф. А4 Квалификация – ведущий инженер. Оклад инженера ~ руб. Оклад инженера ~ руб. Старший инженер ~ руб. Старший инженер ~ руб. Ведущий инженер ~ руб. Ведущий инженер ~ руб.

36 Пример расчета стоимости ТЗ Условие: Заказчику требуется проект технического задания на АС с количеством оговариваемых показателей, превосходящим 46. Условие: Заказчику требуется проект технического задания на АС с количеством оговариваемых показателей, превосходящим 46. Решение: Решение: Предварительный объем ТЗ = 25 л. А4 Трудоемкость = 215 ч (ведущий инженер). Фактический объем проекта ТЗ = 60 листов ф. А4. Нормоконтроль: 0,2 60 = 12 ч. (ст. инженер) Технический контроль: документа 0,2 60 = 12 ч. (ст. инженер). Общая продолжительность работ составит = 239 ч или (239 / 8) / 21 = 1,42 мес. Основная заработная плата: 96,4 тыс. руб. Дополнительная заработная плата: 96,4 0,0833 = 8,0 тыс. руб. Износ технических средств при стоимости 100 тыс. руб. и сроке амортизации 5 лет: (100 /(12 5)) 1,42 = 2,3 тыс. руб. Стоимость услуг сторонних организаций (интернет и мобильная связь): ( ) 1,42 = 1,4 тыс. руб. Накладные расходы: 96,4 0,12 = 11,6 тыс. руб. Себестоимость: 96,4 + 8,0 + 2,3 + 1,4 + 11,6 = 119,7 тыс. руб. Прибыль: 0,1 119,7 = 12,0 тыс. руб. Стоимость работ: 119,7 + 12,0 = 131,7 тыс. руб.

37 Расчет стоимости работ по созданию ТД Базовая цена разработки ТД определяется в зависимости от количества баллов, подсчитанных по основным факторам трудоемкости, соответствующего ценностного множителя и общего поправочного коэффициента: Ц баз = S x Б x К Цены установлены отдельно на разработку каждой из следующих частей проектной документации на АСУТП: общесистемные решения (ОР); организационное обеспечение (ОО); информационное обеспечение (ИО); техническое обеспечение (ТО). математическое обеспечение (МО). программное обеспечение (ПО).

38 Факторы трудоемкости разработки проектной документации на АСУТП Характер протекания управляемого технологического процесса во времени (непрерывный, циклический, дискретный) Количество технологических операций, контролируемых или управляемых АСУТП Степень развитости информационных функций АСУТП (I-IV) Степень развитости управляющих функций АСУТП (I-VII) Режим выполнения управляющих функции АСУТП (автоматизированный/автоматический, всего 5 режимов) Количество переменных, измеряемых, контролируемых и регистрируемых АСУТП Количество управляющих воздействий, вырабатываемых АСУТП

39 Ориентировочное распределение базовой цены двухстадийной разработки ТД Части ТДТПРД Общесистемные решения 70-80%20-30% Организационное обеспечение 30-40%60-70% Информационное обеспечение 40-50%50-60% Техническое обеспечение 40-50%50-60% Математическое обеспечение 80-90%10-20% Программное обеспечение 10-20%80-90%

40 Пример определения цены разработки проектной документации на АСУТП Исходные данные по факторам трудоемкости: Характер протекания управляемого технологического процесса во времени – полунепрерывный технологический процесс; Количество технологических операций, контролируемых или управляемых АСУТП – 36; Степень развитости информационных функций АСУТП - III степень (косвенное измерение (вычисление) отдельных комплексных показателей функционирования ТОУ); Степень развитости управляющих функций АСУТП - IV степень (оптимальное управление установившимися режимами (в статике)); Режим выполнения управляющих функции АСУТП – автоматизированный режим "советчика"; Количество переменных, измеряемых, контролируемых и регистрируемых АСУТП – 365; Количество управляющих воздействий, вырабатываемых АСУТП – 130

41 Пример определения цены разработки проектной документации на АСУТП Исходные данные для поправочных коэффициентов: создаваемая АСУТП является впервые разрабатываемой и подлежит эксплуатации в России; АСУТП создается с использованием зарубежных технических средств (К6); АСУТП подлежит эксплуатации в условиях взрывоопасного производства (К10.1); АСУТП создается на вновь проектируемом технологическом объекте управления; разработка документации выполняется в две стадии.

42 Определение базовой цены для ОР = 29 для ОО = 18 для ИО = 37 для ТО = 32 для МО = 37 для ПО = 37 Сумма баллов для каждого вида документации Повышающий коэффициент К6 = 1,1; К10.1 = 1,3.

43 Определение баллов для факторов трудоемкости Пример для фактора 7 (количество управляющих воздействий, вырабатываемых АСУТП = 130) Части ТД Значение фактора ОРООИОТОМОПО

44 Базовая цена двухстадийной разработки проектной документации на АСУТП Части документации Ценностный множитель ОР2,04 ОО1,24 ИО1,83 ТО4,38 МО4,92 ПО6,00