Документирование в процессах ЖЦ.

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

Процесс документирования состоит из следующих действий: реализации, проектирование и разработка, производство и сопровождение.

Реализация. Это действие подразумевает следующее.

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

Проектирование и разработка. Это действие состоит из следующих задач.а) Каждый документ должен быть спроектирован в соответствии с применяемыми стандартами по формату, содержанию, нумерации страниц, размещению рисунков/таблиц, отметке о приоритете/секретности, упаковке и другим пунктам.б) Источник и соответствие входных данных для документов должны быть гарантированы. Должны быть использованы автоматические средства документирования.в) Подготовленные документы должны быть просмотрены и отредактированы с точки зрения формата, технического содержания и стиля представления в соответствии со стандартами по документации. Они должны быть утверждены ответственным за их выпуск.

Производствоа) Документы должны быть произведены и упакованы. В соответствии с планом, ими должны быть обеспечены все заинтересованные стороны. Производство и распространение документов может быть выполнено в бумажном, электронном виде. Исходные материалы должны храниться в соответствии с условиями записи, секретности, сопровождения и резервных копий проекта.б) Контроль должен быть представлен в соответствии с процессом управления конфигурированием.

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

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

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

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

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

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

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

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

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

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

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

Определение качества документов.

Руководители должны выбирать стандарты, распространяющиеся на уровень качества, соответственно различным типам документов и различным типам проектов и должны определять, как это качество будет достигнуто и поддержано.

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

Определение форматов документов.

Стандартизованные форматы документов важны для контроля качества документов, для читаемости документов и для облегчения их сопровождения.

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

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

Определение системы обозначения документов.

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

Если документы выпускаются в виде разрозненных листов, каждая страница должна иметь индивидуальное обозначение (например, со ссылочным номером документа, номером страницы и номером издания).