разработки

ТЕМА 4.
Технологии внедрения
информационных систем
Лекция 19.
Разработка проектной и эксплуатационной
документации на ИС.
Нормативные документы, регламентирующие
процесс документирования

ГОСТ Р ИСО/МЭК 12207-99
«Информационная технология. Процессы
жизненного цикла программных средств»

ГОСТ Р ИСО/МЭК ТО 9294-93
«Информационная технология. Руководство по
управлению документированием программного
обеспечения»

ГОСТ Р ИСО/МЭК 15910-2002
«Информационная технология. Процесс создания
документации пользователя программного средства»
2
Группы процессов ЖЦ по стандарту
ISO/IEC 12207
Основные
процессы
Вспомогательные
процессы
Организационные
процессы
•приобретение;
•поставка;
•разработка;
•эксплуатация;
•сопровождение
•документирование;
•управление
конфигурацией;
•обеспечение
качества;
•разрешение
проблем;
•аудит;
•аттестация;
•совместная оценка;
•верификация.
•создание
инфраструктуры;
•управление;
•обучение;
•усовершенствование.
3
Функции технической документации
1) Предоставление информации для управления
процессом разработки ИС;
2) обеспечение связи между задачами и
участниками разработки;
3) обеспечение качества ИС;
4) предоставление методической, инструктивной и
справочной информации;
5) сопровождение программного обеспечения ИС;
6) обеспечение преемственности разработки
(предоставление исторической справки).
4
Типы технической документации
ТД
документация
разработки
•спецификации
требований;
•спецификации
функций;
•проектные
спецификации;
•планы разработки;
•планы сборки и
тестирования ПО;
•планы обеспечения
качества и т.д.
документация
продукции
•технологические
инструкции;
•руководства
пользователя;
•руководства по
сопровождению ПО;
•брошюры и
информационные
листовки,
посвященные
продукции.
документация
управления
проектом
•планы-графики
процесса разработки;
•отчеты о
согласованных
изменениях ПО;
•отчеты о решениях,
связанных с
разработкой;
•распределение
обязанностей.
5
Цели документации разработки
1.
2.
3.
4.
5.
Являются средством связи между
участниками процесса разработки ИС.
Описывают обязанности группы
разработки.
Выступают в качестве контрольных точек
проекта разработки.
Являются основой документации
сопровождения ПО.
Описывают историю разработки ПО.
6
Цели документации продукции
Обеспечивает учебную и справочную информацию
для пользователей.
2. Облегчает программистам заказчика
сопровождение ПО.
3. Помогает в приемке и продаже продукции.
В соответствии с целями документация продукции
предназначена для следующих типов читателей:
1. Конечные пользователи
2. Тестировщики
3. Сопровождающие программисты
4. Руководители
1.
7
Принципы документирования
1.
2.
3.
4.
5.
6.
Документация охватывает весь жизненный цикл
ИС
Документирование должно быть управляемым
Документация должна соответствовать ее
читательской аудитории.
Работы по документированию должны быть
объединены в общий процесс разработки
программного обеспечения
Должны быть определены и использованы
стандарты по документированию
Должны быть определены средства поддержки
процесса документирования
8
Ресурсы процесса документирования

Персонал
проектировщики и программисты
 специалисты предметной области
 разработчики технической документации
(технические писатели, документаторы)


Средства документирования
ручные и механические средства
 технические средства
 автоматизированные средства разработки
документации


Финансовые средства
9
Процесс документирования
1. Подготовка процесса (определение перечня
документов, разрабатываемых в процессе
создания ИС)





наименование
назначение
пользователи
технологический процесс разработки
сроки выпуска
2. Проектирование и разработка документов
3. Выпуск документов
4. Сопровождение документации
ГОСТ Р ИСО 12207-99
10
Разработка эксплуатационной
документации
I этап
Получение исходных
материалов (заказчик,
документатор) – п. 8.1.2.
Разработка плана
документирования
(документатор) – п. 8.1.3
Проверка плана
документирования
(заказчик) – п. 8.1.4.2
II этап
Разработка документации в
соответствии с планом
(документатор)
Проверка
документации
(заказчик) –
п. 8.1.4.3-8.1.4.5
Тестирование на
практичность
(документатор,
заказчик) – п. 8.1.5
Тиражирование и
распространение
(документатор) – п. 8.1.3.1
ГОСТ Р ИСО/МЭК 15910-2002 11
Содержание плана документирования
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
рабочее наименование, назначение, область применения и ограничения по
использованию;
спецификация стиля;
определение аудитории пользователей;
содержание документации с оценкой ее постраничного объема;
номенклатура поставки;
установление собственника авторских прав на документацию;
обеспечение перевода документации на другие языки.
уровни (грифы) секретности и конфиденциальности (при необходимости);
процедуры и проверки, могущие влиять на процесс разработки документации;
методы и средства производства и используемые версии данных средств;
структура коллектива разработчиков документации;
взаимосвязи (подчиненности) проекта;
почасовая загрузка и зарплата персонала;
требования к проектным ресурсам, включая информационные и прочие ресурсы,
представляемые заказчиком, и срокам их представления;
метод передачи документатору информации об изменениях программного
средства в процессе его разработки;
планы контроля изменений и сопровождения документации;
планы проверки документации после ее создания;
календарное планирование по контрольным точкам.
12
Определение качества
документирования



качество содержания можно измерять в
элементах точности, полноты и ясности;
качество структуры можно измерять
легкостью, с которой читатель имеет
возможность определить местоположение
информации;
качество представления должно
соответствовать типу проекта.
13
Методы оценки трудоемкости
разработки ТД

ГОСТ Р ИСО/МЭК 15910-2002
«Информационная технология. Процесс создания
документации пользователя программного
средства»
 Метод нисходящего проектирования
 Поминутно-почасовой метод

Метод оценки трудоемкости разработки
технической документации по аналогии с
методом оценки трудоемкости разработки
ПО (метод функциональных точек).
14
Метод нисходящего проектирования
1.
2.
3.
Разделить документацию на части.
Оценить объем каждой части в страницах.
При планировании работ исходить из
нормативов выпуска технической
документации.
автор может за месяц подготовить 22 страницы
нового текста;
 автор может за месяц подготовить 44 страницы
текста с изменениями.

15
Метод нисходящего проектирования

15 % - планирование:
1)
2)
3)

исследование и подготовка плана;
изучение и проверка плана;
корректировка плана по результатам проверки.
50 % - написание первой редакции:
1)
2)
3)
4)
5)
6)
7)
8)
подготовка содержания документации;
изучение и проверка содержания;
подготовка пробного куска текста для редактора;
редактирование пробного куска текста и его
переписывание по замечаниям редактора;
написание всей первой редакции документации;
редактирование всей первой редакции документации;
переработка отредактированной документации;
изучение и проверка переработанной документации.
16
Метод нисходящего проектирования

25 % - написание второй редакции:
1)
2)
3)
4)

внесение в документацию всех изменений, предложенных
по результатам проверки первой редакции;
повторное редактирование второй редакции
документации;
переработка отредактированной документации;
изучение и проверка переработанной документации.
10 % - подготовка фотошаблонов (скриншотов):
1)
2)
3)
4)
5)
внесение в документацию всех изменений, предложенных
по результатам проверки второй редакции;
проверка правильности внесения данных изменений;
удаление всех редакционных разметок;
изготовление фотошаблонов;
отправку фотошаблонов в печать (в типографию).
17
Поминутно-почасовой метод
Определение номенклатуры поставки
Исследование содержания документации
Написание плана документирования
Проектирование структуры документа и правил
оформления его страниц
5)
Написание первой редакции (документации)
6)
Разработка графических материалов
7) Объединение текстовых и графических материалов
8)
Проверка первой редакции (эксперт)
9)
Корректировка первой редакции и графики
10) Внесение замечаний пользователя
11) Грамматическое редактирование
12) Подготовка второй редакции (документации)
13) Проверка второй редакции (эксперт)
14) Окончательная корректировка документации
15) Нормоконтроль документации
16) Изготовление фотошаблонов
17) Печать и переплетение оригиналов
18) Печать и брошюровка копий
19) Рассылка
1)
2)
3)
4)
16 ч на проект
24 ч на проект
48 ч на проект
8 ч на том
1 ч на страницу
5 ч на материал
30 мин на страницу
30 мин на страницу
30 мин на страницу
30 мин на страницу
15 мин на страницу
15 мин на страницу
15 мин на страницу
10 мин на страницу
15 мин на страницу
3 сут.
5 сут.
10 сут.
1 сут.
18
Метрики документирования
Метрики
проекта
Метрики
пользовательской
перспективы
Метрики данных Метрики
интерфейса
пользователя
Объем
Количество
Количество
Количество
доступной
документации;
Количество
экспертов
Количество
рецензентов
функциональных
ролей;
Количество
пользовательских
задач;
Количество
функций программы;
Количество
реакций
пользователя на
сообщения
программы
сущностей;
Количество
атрибутов
объектов;
Количество
поддерживаемых
форматов данных
главных окон и
рабочих
областей;
Количество
крупных
экранных форм;
Количество
команд главного
меню;
Количество
сообщений об
ошибках
19
Последовательность разработки
эксплуатационной документации
Изучение
продукта
•Чтение
документации;
•Интервью;
•Работа на
стенде
Составление
плана
документирования
•Анализ требований
к документу;
•Составление
структуры
документа;
•Составление и
согласование плана
документирования
Написание
текста
Согласование
текста
Оформление
текста
•Изложение
структурной
информации;
•Изложение
процедурной
информации;
•Изложение
справочной
информации;
•Подготовка
рисунков
•Обсуждение
замечаний;
•Внесение
исправлений
•Авторская
разметка;
•Расстановка
перекрестных
ссылок;
•Разметка
указателя
20
Для решаемой задачи измеряются значения каждого показателя из списка
метрик.
Для каждого вида работ рассчитывается трудоемкость по формуле:
Трудоемкостьi = Метрика1*Ti1 + Метрика2*Ti2 +…+ МетрикаN*T
21 iN.
Средства автоматизированного
документирования





Technical Guide Builder
WackoWiki
AuthorIT
Adobe FrameMaker
IBM Rational SoDA
22
Экспертиза технической
документации


Экспертиза документации определяет
согласованность документов, разработанных
на разных стадиях создания ИС.
Согласованность – главное требование к
технической документации, выражающееся
в непротиворечивости сведений, излагаемых
в отдельных документах, входящих в состав
комплекта технической документации.
23
Цели и задачи экспертизы ТД
ЦЕЛИ:
 снижение финансовых рисков заказчика и
исполнителя при создании ИС;
 сокращение сроков ввода ИС в действие.
ЗАДАЧИ:
 проверка технической документации на
комплектность;
 проверка структуры разделов технической
документации на соответствие требованиям
стандартов, нормативных документов и актов;
 проверка соответствия содержательной части
технической документации требованиям НТД и
техническим требованиям организации-эксперта.
24
Техническая документация,
подлежащая экспертизе





Техническое задание на создание
автоматизированной системы;
Технический или технорабочий проект;
Документы, разрабатываемые на стадии
«Рабочая документация»;
Эксплуатационная документация;
Программа и методики испытаний.
25
Взаимосвязь технической
документации
Требования
Стадия
Техническое
анализа
задание
предметной
области
Проектная
стадия
Стадия
реализации
(разработки)
Решения
Пояснительная
записка
к техническому
проекту
Сведения о
системе
Общее описание
системы
(рабочий проект)
26
Техническое задание Пояснительная
записка к ТП
Общее описание
системы
перечень подсистем,
их назначение и
основные
характеристики...
требования к
характеристикам
взаимосвязей системы
со смежными
системами,
требования к ее
совместимости
описание
взаимосвязей АС с
другими системами
решения по
сведения об АС в
структуре системы, целом и ее частях...
подсистем…
решения по
взаимосвязям АС
со смежными
системами,
обеспечению ее
совместимости
требования к режимам решения по
описание
функционирования
режимам
функционирования
системы
функционирования системы
27
28
Разработка документации на ИС

Документация на ИС включает:




Документация на ПО:




документацию на ПО;
документацию на ТС;
документацию для персонала.
руководство пользователя,
руководство системного администратора
руководство программиста.
Задача технологической инструкции – соотнести
функциональность ПО автоматизированной системы
с практикой, описать работу пользователей ИС по
существу.
29
Причины разделения
технологической инструкции и
руководства пользователя
1. Одни и те же функции ПО могут использоваться разными
сотрудниками при выполнении разных операций.
2. Процессы сопровождения ПО и реинжиниринга
организационной структуры могут протекать по-разному.
Объединение программной и организационной части в
одном документе осложнит его обновление и
согласование.
3. Текст инструкции, предназначенной для пользователя,
будет перегружен техническими деталями, осложняющими
общее понимание технологической операции.
30
Технологическая инструкция


Технологическая инструкция – сборник описаний
технологических операций.
Технологическая операция (в проектировании) – основная
единица работы, выполняемая определенной ролью,
которая:




подразумевает четко определенную ответственность роли;
дает четко определенный результат (набор рабочих продуктов),
базирующийся на определенных исходных данных;
представляет собой единицу работы с жестко определенными
границами, которые устанавливаются при планировании проекта.
Технологическая операция (в бизнес-процессе
пользователя) – связное действие, выполняемое одним
субъектом в течение ограниченного времени и приводящее
к осмысленному результату безотносительно средств его
достижения.
31
Элементы технологической инструкции



Триггер – событие или обстоятельство, при
наступлении которого пользователь выполняет
операцию.
Результат операции – существенное изменение
ситуации, которое происходит после ее успешного
выполнения. Результат не следует путать с
выходными данными или документами.
Пошаговое описание выполнения операции,
подробность и объем которого во многом
определяются особенностями АС.


Способ проверки успешности выполнения операции.
Описание нештатных ситуаций и возможных действий в
них.
32
Расчет стоимости работ по
созданию ТД

Базовая цена разработки ТД определяется в зависимости
от количества баллов, подсчитанных по основным
факторам трудоемкости, соответствующего ценностного
множителя и общего поправочного коэффициента:
Цбаз = S x Б x К

Цены установлены отдельно на разработку каждой из
следующих частей проектной документации на АСУТП:






общесистемные решения (ОР);
организационное обеспечение (ОО);
информационное обеспечение (ИО);
техническое обеспечение (ТО).
математическое обеспечение (МО).
программное обеспечение (ПО).
33
Факторы трудоемкости разработки
проектной документации на АСУТП
1. Характер протекания управляемого технологического
процесса во времени (непрерывный, циклический,
дискретный)
2. Количество технологических операций, контролируемых или
управляемых АСУТП
3. Степень развитости информационных функций АСУТП (I-IV)
4. Степень развитости управляющих функций АСУТП (I-VII)
5. Режим выполнения управляющих функции АСУТП
(автоматизированный/автоматический, всего 5 режимов)
6. Количество переменных, измеряемых, контролируемых и
регистрируемых АСУТП
7. Количество управляющих воздействий, вырабатываемых
АСУТП
34
Ориентировочное распределение базовой
цены двухстадийной разработки ТД
Части ТД
ТП
РД
Общесистемные решения
70-80% 20-30%
Организационное обеспечение
30-40% 60-70%
Информационное обеспечение
40-50% 50-60%
Техническое обеспечение
40-50% 50-60%
Математическое обеспечение
80-90% 10-20%
Программное обеспечение
10-20% 80-90%
35
Пример определения цены разработки
проектной документации на АСУТП
Исходные данные по факторам трудоемкости:
1.
2.
3.
4.
5.
6.
7.
Характер протекания управляемого технологического процесса во
времени – полунепрерывный технологический процесс;
Количество технологических операций, контролируемых или
управляемых АСУТП – 36;
Степень развитости информационных функций АСУТП - III степень
(косвенное измерение (вычисление) отдельных комплексных
показателей функционирования ТОУ);
Степень развитости управляющих функций АСУТП - IV степень
(оптимальное управление установившимися режимами (в статике));
Режим выполнения управляющих функции АСУТП –
автоматизированный режим "советчика";
Количество переменных, измеряемых, контролируемых и
регистрируемых АСУТП – 365;
Количество управляющих воздействий, вырабатываемых АСУТП –
130
36
Пример определения цены разработки
проектной документации на АСУТП
Исходные данные для поправочных коэффициентов:
 создаваемая АСУТП является впервые
разрабатываемой и подлежит эксплуатации в России;
 АСУТП создается с использованием зарубежных
технических средств (К6);
 АСУТП подлежит эксплуатации в условиях
взрывоопасного производства (К10.1);
 АСУТП создается на вновь проектируемом
технологическом объекте управления;
 разработка документации выполняется в две стадии.
37
Определение базовой цены
Сумма баллов для каждого вида документации






для ОР
для ОО
для ИО
для ТО
для МО
для ПО
2+5+6+6+1+4+5= 29
1+3+2+3+1+4+4= 18
2+5+6+7+2+7+8= 37
1+3+5+7+1+7+8= 32
2+5+6+7+2+7+8= 37
2+5+6+7+2+7+8= 37
Повышающий коэффициент
К6 = 1,1;
К10.1 = 1,3.
38
Определение баллов для факторов
трудоемкости

Пример для фактора 7 (количество управляющих
воздействий, вырабатываемых АСУТП = 130)
Части ТД
ОР
ОО
ИО
ТО
МО
ПО
5
4
8
8
8
8
Значение
фактора
120-160
39
Базовая цена двухстадийной разработки
проектной документации на АСУТП
Части документации
Ценностный множитель
ОР
2,04
ОО
1,24
ИО
1,83
ТО
4,38
МО
4,92
ПО
6,00
40