Оптимизация системы документирования информационных систем в компании ООО «БФТ»
|
ВВЕДЕНИЕ 5
1 Описание предметной области 8
1.1 Концептуальный подход документирования программных продуктов ... 8
1.2 Рекомендации по стилю изложения информации 16
1.2.1 Структурированность 16
1.2.2 Строгость 18
1.2.3 Детальность 20
1.2.4 Единообразие 21
1.2.5 Однозначность 22
1.2.6 Лаконичность 24
1.3 Принципы построения набора стилей для технического документа 26
2 Проектирование оптимизированной системы документирования 28
2.1 Процесс подготовки документации «как есть» 28
2.1.1 Получение списка доработок 31
2.1.2 Предварительный анализ доработок 31
2.1.3 Проектирование списка документов 32
2.1.4 Составление плана разработки и обновления документации 33
2.1.5 Разработка или обновление документации 33
2.1.6 Тестирование документации 35
2.1.7 Формирование комплекта документации 35
2.1.8 Сопровождение документации 35
2.1.9 Описание модели «как есть» и ее анализ 36
2.2 Проектирование оптимизированной модели процесса подготовки
документации 38
2.2.1 Получение списка доработок 39
2.2.2 Предварительный анализ доработок 40
2.2.3 Составление и согласование плана работ 41
2.2.4 Выполнение задач по документированию 41
2.2.5 Предоставление документации 44
2.3 Оптимизация производственных процессов 45
2.3.1 Учет заданий документирования в едином инструментарии учета
всех производственных задач 45
2.3.2 Анализ и выбор оптимального специализированного программного
обеспечения подготовки документации 50
2.4 Проектирование модели оптимизированной системы
документирования 52
3 Разработка и исследование оптимизированной системы документирования 56
3.1 Используемые инструментальные средства разработки 56
3.2 Описание форматов обмена данными 58
3.3 Описание классов и методов интеграционной шины 70
3.4 Описание работы интеграционной шины в оптимизированной
системе документирования 75
3.5 Экономический эффект от оптимизированной системы
документирования 81
ЗАКЛЮЧЕНИЕ 83
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ 85
ПРИЛОЖЕНИЕ А 89
ПРИЛОЖЕНИЕ Б 115
1 Описание предметной области 8
1.1 Концептуальный подход документирования программных продуктов ... 8
1.2 Рекомендации по стилю изложения информации 16
1.2.1 Структурированность 16
1.2.2 Строгость 18
1.2.3 Детальность 20
1.2.4 Единообразие 21
1.2.5 Однозначность 22
1.2.6 Лаконичность 24
1.3 Принципы построения набора стилей для технического документа 26
2 Проектирование оптимизированной системы документирования 28
2.1 Процесс подготовки документации «как есть» 28
2.1.1 Получение списка доработок 31
2.1.2 Предварительный анализ доработок 31
2.1.3 Проектирование списка документов 32
2.1.4 Составление плана разработки и обновления документации 33
2.1.5 Разработка или обновление документации 33
2.1.6 Тестирование документации 35
2.1.7 Формирование комплекта документации 35
2.1.8 Сопровождение документации 35
2.1.9 Описание модели «как есть» и ее анализ 36
2.2 Проектирование оптимизированной модели процесса подготовки
документации 38
2.2.1 Получение списка доработок 39
2.2.2 Предварительный анализ доработок 40
2.2.3 Составление и согласование плана работ 41
2.2.4 Выполнение задач по документированию 41
2.2.5 Предоставление документации 44
2.3 Оптимизация производственных процессов 45
2.3.1 Учет заданий документирования в едином инструментарии учета
всех производственных задач 45
2.3.2 Анализ и выбор оптимального специализированного программного
обеспечения подготовки документации 50
2.4 Проектирование модели оптимизированной системы
документирования 52
3 Разработка и исследование оптимизированной системы документирования 56
3.1 Используемые инструментальные средства разработки 56
3.2 Описание форматов обмена данными 58
3.3 Описание классов и методов интеграционной шины 70
3.4 Описание работы интеграционной шины в оптимизированной
системе документирования 75
3.5 Экономический эффект от оптимизированной системы
документирования 81
ЗАКЛЮЧЕНИЕ 83
СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ 85
ПРИЛОЖЕНИЕ А 89
ПРИЛОЖЕНИЕ Б 115
По мере роста числа создаваемых и вводимых в действие информационных систем все более остро встает вопрос сокращения сроков и снижения трудоемкости разработки и поддержания в актуальном состоянии, в том числе и документации.
Разработка документации на информационную систему предполагает подготовку целого ряда документов: концептуальных, отчетных, проектных, рабочих, эксплуатационных и организационно-распорядительных. Итоговый объем документации системы, включающей в себя текстовую и графическую информацию, как правило, составляет десятки, а иногда и сотни тысяч страниц.
Разработка и поддержание документации в актуальном состоянии на всех стадиях и этапах жизненного цикла информационной системы вызывает немало проблем. В большей степени они связаны, с необходимостью многократного внесения в документацию, состоящую из множества отдельных файлов, всевозможных поправок, дополнений и изменений.
Ситуация отягощается еще и тем, что:
- «государственный» заказчик, финансирующий львиную долю разрабатываемых информационных систем, все чаще и чаще требует от исполнителя строжайшего и неформального соблюдения требований ГОСТ при разработке технической документации;
- требования отечественных ГОСТов несоизмеримо более жесткие по сравнению с требованиями зарубежных стандартов;
- специалистов, способных удовлетворить требованиям заказчика (соблюдение требований ГОСТ), в ВУЗах практически не готовят, так как их подготовка все больше сводится к так называемому «процессному подходу».
Корректировка документов - трудоемкая операция, требующая от технического писателя аккуратности, высокой сосредоточенности, отнимающая массу времени, сил и нервов.
Использование современных технологий позволяющих осуществить переход от «классического» метода документирования к методу документирования по «принципу единого источника» - разумный путь оптимизации процесса документирования, позволяющий получить стабильное качество документации, сократить сроки разработки документации и снизить трудоемкость поддержание комплекта документов в актуальном состоянии.
Предпосылки оптимизации процесса подготовки документации, прослеживаются в формулировках ГОСТов 34-й серии:
- Приложение 1 ГОСТ 34.201-89: «Документация на
автоматизированную систему - комплекс взаимоувязанных документов, в котором полностью описаны все решения по созданию и функционированию системы, а также документов, подтверждающих соответствие системы требованиям технического задания и готовность ее к эксплуатации (функционированию)» [1].
- п. 5.1 ГОСТ 34.003-90: «Комплект взаимоувязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС» [2].
Объектом исследования является процесс документирования информационных систем в компании БФТ.
Предметом исследования являются методы и средства процесса документирования информационных систем.
Целью данной работы является оптимизация системы документирования информационных систем в компании БФТ.
Для достижения поставленной цели необходимо решить следующие задачи:
- изучить предметную область;
- исследовать существующие методы подготовки документации;
- проанализировать и описать модель существующего процесса документирования;
Разработка документации на информационную систему предполагает подготовку целого ряда документов: концептуальных, отчетных, проектных, рабочих, эксплуатационных и организационно-распорядительных. Итоговый объем документации системы, включающей в себя текстовую и графическую информацию, как правило, составляет десятки, а иногда и сотни тысяч страниц.
Разработка и поддержание документации в актуальном состоянии на всех стадиях и этапах жизненного цикла информационной системы вызывает немало проблем. В большей степени они связаны, с необходимостью многократного внесения в документацию, состоящую из множества отдельных файлов, всевозможных поправок, дополнений и изменений.
Ситуация отягощается еще и тем, что:
- «государственный» заказчик, финансирующий львиную долю разрабатываемых информационных систем, все чаще и чаще требует от исполнителя строжайшего и неформального соблюдения требований ГОСТ при разработке технической документации;
- требования отечественных ГОСТов несоизмеримо более жесткие по сравнению с требованиями зарубежных стандартов;
- специалистов, способных удовлетворить требованиям заказчика (соблюдение требований ГОСТ), в ВУЗах практически не готовят, так как их подготовка все больше сводится к так называемому «процессному подходу».
Корректировка документов - трудоемкая операция, требующая от технического писателя аккуратности, высокой сосредоточенности, отнимающая массу времени, сил и нервов.
Использование современных технологий позволяющих осуществить переход от «классического» метода документирования к методу документирования по «принципу единого источника» - разумный путь оптимизации процесса документирования, позволяющий получить стабильное качество документации, сократить сроки разработки документации и снизить трудоемкость поддержание комплекта документов в актуальном состоянии.
Предпосылки оптимизации процесса подготовки документации, прослеживаются в формулировках ГОСТов 34-й серии:
- Приложение 1 ГОСТ 34.201-89: «Документация на
автоматизированную систему - комплекс взаимоувязанных документов, в котором полностью описаны все решения по созданию и функционированию системы, а также документов, подтверждающих соответствие системы требованиям технического задания и готовность ее к эксплуатации (функционированию)» [1].
- п. 5.1 ГОСТ 34.003-90: «Комплект взаимоувязанных документов, полностью определяющих технические требования к АС, проектные и организационные решения по созданию и функционированию АС» [2].
Объектом исследования является процесс документирования информационных систем в компании БФТ.
Предметом исследования являются методы и средства процесса документирования информационных систем.
Целью данной работы является оптимизация системы документирования информационных систем в компании БФТ.
Для достижения поставленной цели необходимо решить следующие задачи:
- изучить предметную область;
- исследовать существующие методы подготовки документации;
- проанализировать и описать модель существующего процесса документирования;
В ходе выполнения магистерской диссертации были достигнуты следующие результаты:
а) изучена предметная область - документирование программных продуктов, рассмотрен концептуальный подход документирования программных продуктов, «взаимоувязанность» различных документов на разных стадиях существования программного продукта;
б) исследованы методы подготовки документации: «классический» и по «принципу единого источника»; показано, что для повышения качества документации и экономии трудовых ресурсов при разработке и актуализации различных взаимоувязанных документов необходимо использование «принципа единого источника»;
в) рассмотрены рекомендации по стилю изложения информации для определения степени возможной унификации: структурированности, строгости, детальности, единообразия, однозначности, лаконичности; приведено обоснование их использования; расписаны принципы построения набора стилей для технического документа;
г) рассмотрен процесс подготовки документации в компании БФТ «как есть», описана применяемая в настоящее время модель процесса документирования в компании, базирующаяся на классическом методе составления документации;
д) выявлены существующие недостатки в процессе подготовки документации и используемых инструментариях, для устранения которых проведена оптимизация производственных процессов с переходом на единую базу учета и хранения всех корпоративных знаний, в том числе аналитических данных - Confluence и на централизованную систему учета всех производственных задач - JIRA;
е) разработан и описан процесс учета заданий документирования в едином инструментарии учета всех производственных задач компании, осуществлен анализ и выбор специализированного программного обеспечения по подготовке документации основывающего на принципе единого источника и включающего полный цикл работы с документами, от написания до формирования готовых документов;
ж) составлена и описана декомпозированная диаграмма в нотации IDEF0 представляющая собой модель процесса подготовки документации после оптимизации: с переструктурированием и сокращением бизнес-процессов с восьми до пяти;
з) разработана модель системы документирования, базирующаяся на
принципе единого источника, способная в реальном времени и с минимальными трудозатратами предоставлять актуализированную
документацию на любой стадии существования информационных продуктов;
и) осуществлена разработка интеграционной шины слияния
оптимизированной системы документирования: специализированного
программного обеспечения документирования с единой базой хранения всех корпоративных знаний и централизованной системой учета производственных задач, обеспечивающей возможность использования универсальной модели системы документирования для ИТ-решений в любых прикладных отраслях;
к) определен экономический эффект от использования оптимизированной системы документирования, показывающий сокращение трудозатрат на подготовку и поддержание в актуальном состоянии документации систем;
л) осуществлено внедрение оптимизированной модели системы документирования информационных систем в компании БФТ.
а) изучена предметная область - документирование программных продуктов, рассмотрен концептуальный подход документирования программных продуктов, «взаимоувязанность» различных документов на разных стадиях существования программного продукта;
б) исследованы методы подготовки документации: «классический» и по «принципу единого источника»; показано, что для повышения качества документации и экономии трудовых ресурсов при разработке и актуализации различных взаимоувязанных документов необходимо использование «принципа единого источника»;
в) рассмотрены рекомендации по стилю изложения информации для определения степени возможной унификации: структурированности, строгости, детальности, единообразия, однозначности, лаконичности; приведено обоснование их использования; расписаны принципы построения набора стилей для технического документа;
г) рассмотрен процесс подготовки документации в компании БФТ «как есть», описана применяемая в настоящее время модель процесса документирования в компании, базирующаяся на классическом методе составления документации;
д) выявлены существующие недостатки в процессе подготовки документации и используемых инструментариях, для устранения которых проведена оптимизация производственных процессов с переходом на единую базу учета и хранения всех корпоративных знаний, в том числе аналитических данных - Confluence и на централизованную систему учета всех производственных задач - JIRA;
е) разработан и описан процесс учета заданий документирования в едином инструментарии учета всех производственных задач компании, осуществлен анализ и выбор специализированного программного обеспечения по подготовке документации основывающего на принципе единого источника и включающего полный цикл работы с документами, от написания до формирования готовых документов;
ж) составлена и описана декомпозированная диаграмма в нотации IDEF0 представляющая собой модель процесса подготовки документации после оптимизации: с переструктурированием и сокращением бизнес-процессов с восьми до пяти;
з) разработана модель системы документирования, базирующаяся на
принципе единого источника, способная в реальном времени и с минимальными трудозатратами предоставлять актуализированную
документацию на любой стадии существования информационных продуктов;
и) осуществлена разработка интеграционной шины слияния
оптимизированной системы документирования: специализированного
программного обеспечения документирования с единой базой хранения всех корпоративных знаний и централизованной системой учета производственных задач, обеспечивающей возможность использования универсальной модели системы документирования для ИТ-решений в любых прикладных отраслях;
к) определен экономический эффект от использования оптимизированной системы документирования, показывающий сокращение трудозатрат на подготовку и поддержание в актуальном состоянии документации систем;
л) осуществлено внедрение оптимизированной модели системы документирования информационных систем в компании БФТ.