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

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

2 2 Структура жизненного цикла ИС по стандарту ISO/IEC 15288:2005 Процессы соглашения Процессы предприятия Проектные процессы Технические процессы приобретение;поставка управление средой предприятия; инвестиционное управление; управление ЖЦ ИС; управление ресурсами; управление качеством. планирование проекта; оценка проекта; контроль проекта; управление рисками; управление конфигурацией; управление информацией; принятие решений определение требований правообладателей; анализ требований; проектирование архитектуры; реализация элементов системы; интеграция;верификация;передача; аттестация (валидация); функционирование;сопровождение;утилизация.

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

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

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

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

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

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

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

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

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

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

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

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

15 15 Содержание плана документирования 1. рабочее наименование, назначение, область применения и ограничения по использованию; 2. спецификация стиля; 3. определение аудитории пользователей; 4. содержание документации с оценкой ее постраничного объема; 5. номенклатура поставки; 6. установление собственника авторских прав на документацию; 7. обеспечение перевода документации на другие языки. 8. уровни (грифы) секретности и конфиденциальности (при необходимости); 9. процедуры и проверки, могущие влиять на процесс разработки документации; 10. методы и средства производства и используемые версии данных средств; 11. структура коллектива разработчиков документации; 12. взаимосвязи (подчиненности) проекта; 13. почасовая загрузка и зарплата персонала; 14. требования к проектным ресурсам, включая информационные и прочие ресурсы, представляемые заказчиком, и срокам их представления; 15. метод передачи документатору информации об изменениях программного средства в процессе его разработки; 16. планы контроля изменений и сопровождения документации; 17. планы проверки документации после ее создания; 18. календарное планирование по контрольным точкам.

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

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

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

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

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

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

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

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

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

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

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

27 27

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