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

Структура жизненного цикла ИС по стандарту ISO/IEC 15288:2005

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

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

Функции программной документации
Предоставление информации для управления процессом разработки ИС;
обеспечение связи между задачами и участниками разработки;
обеспечение качества ИС;
предоставление методической, инструктивной и справочной информации;
сопровождение программного обеспечения ИС;
обеспечение преемственности разработки (предоставление исторической справки).

Принципы документирования
Документация охватывает весь жизненный цикл ИС
Документирование должно быть управляемым
Документация должна соответствовать ее читательской аудитории.
Работы по документированию должны быть объединены в общий процесс разработки программного обеспечения
Должны быть определены и использованы стандарты по документированию
Должны быть определены средства поддержки процесса документирования

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

Цели документации разработки
Средство связи между участниками разработки;
Описание обязанностей участников группы разработки;
Определение контрольных точек для оценки хода разработки;
Создание основы документации сопровождения ПО;
Отражение истории разработки ПО.

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

Цели документации продукции
Обеспечение учебной и справочной информацией пользователей ИС;
Облегчает сопровождение и модернизацию;
Помогает приемке и продаже программной продукции.

Категории программной документации
Типовые документы:
планы-графики процесса разработки;
отчеты о согласованных изменениях ПО;
отчеты о решениях, связанных с разработкой;
распределение обязанностей.

Процесс документирования
Подготовка процесса (определение перечня документов, разрабатываемых в процессе создания ИС)
наименование
назначение
пользователи
технологический процесс разработки
сроки выпуска
Проектирование, разработка и выпуск документов
Сопровождение документации

Ресурсы процесса документирования
Персонал
проектировщики и программисты
специалисты предметной области
разработчики технической документации (технические писатели, документаторы)
Средства документирования
ручные и механические средства
технические средства
автоматизированные средства разработки документации
Финансовые средства

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

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

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

Последовательность разработки эксплуатационной документации

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

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

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

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

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

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

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

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