Документирование проекта в соответствии с международной стандартизацией
Стандарты, регламентирующие документирование программ и данных. Общие требования к составу и содержанию документов, поддерживающих создание ПС и БД, представлены в ряде стандартов разного ранга, в фирменных описаниях технологий и в публикациях по управлению проектами. В стандартах DOD 2167 А и DOD 2168 требования к документации предписываются как обязательные, а в остальных случаях имеют преимущественно рекомендательный характер. Состав документов широко варьируется в зависимости от класса и характеристик объекта разработки, а также в зависимости от используемой технологии. Наиболее сложному случаю разработки критических ПС высокого качества соответствует самая широкая номенклатура документов. Такой перечень документов может быть использован как базовый для формирования из него состава документов в остальных более простых случаях. Документирование проектов и результатов тестирования комплексов программ и их компонентов наиболее полно представлено в стандарте ANSI/IEEE 829, который целесообразно также использовать как основу разработке мобильных ПС. Всю документацию, обеспечивающую проектирование ПС и БД, можно разделить на обобщающую, охватывающую функциональное назначение ИС, и на детализирующую результаты отдельных этапов разработки.
В базовых стандартах жизненного цикла ПС ISO 12207 и ISO 9000-3 различной глубиной определено содержание этапов и частных работ при создании и модификации ПС и их компонентов. Для планирования и управления проектами ПС эти стандарты служат структурной базой объектов и работ при детализации требований в профиле документирования, в который могут входить стандарты:
1. ISO 6592:1985. ОИ. Руководство по документации для вычислительных систем.
2. ISO 9294:1990-TO. ИТ. Руководство по управлению документированием программного обеспечения.
3. ISO 9127:1988. СОИ. Пользовательская и рекламная документация на пакеты программ.
4. ANSI/IEEE 1063:1987 (ред. 1993). Пользовательская документация на программные средства.
Главная цель стандарта ISO 6592 – состоит в установлении базисной структуры документации, на основе которой возможно для любого проекта обеспечить эффективное совершенствование и реализацию информационной системы, ПС и БД. В стандарте установлены руководящие принципы создания документов для информационных систем. Эти принципы разработаны с целями обеспечения: эффективного взаимодействия всех разработчиков прикладной ИС; создания хорошо спланированной, стандартной документации системы; адекватной модификации документации на ПС и БД, параллельно с их совершенствованием.
Указывается, что хорошо определенные правила документирования процесса совершенствования ИС упростят: подготовку самой документации; оценку времени и затрат ресурсов для реализации проекта; обмен информацией между разработчиками системы, что приведет к выбору достижимых целей ИС и более обоснованному функциональному проектированию; принятие решений и консультации с персоналом во время работы по совершенствованию системы.
Документация, разработанная по руководящим указаниям стандарта, обеспечивает:
· оперативный контроль руководства за процессом развития и совершенствования системы;
· позволяет пользователям эффективно и правильно использовать ИС, ПС и БД;
· позволяет операторам вычислительных машин составлять график работы и работать на системе;
· помогает диагностировать и корректировать аномалии и ошибки;
· предоставляет информацию о состоянии ПС и БД для поддержки их эксплуатации.
Отдельный документ или его раздел может быть бесполезным для одной системы, но важным для другой, и поэтому допускается корректировка состава документации. Рекомендуется применять таблицу контрольных проверок соответствия реальной документации на ИС международному стандарту. Это гарантирует, что пропуск некоторой информации в документах будет лишь намеренным, после принятия решения, а не в результате просмотра.
В стандарте идентифицированы два базисных типа информации: административная и техническая. Административная информация поступает от средств управления системой и руководства в виде записей – приказов и выполненных заданий. Рекомендуется сохранять эту информацию, но ее не обязательно обновлять, если реализация системы завершена. В техническую информацию входят описания всех аспектов ИС в настоящий момент времени, в том числе аппаратных и программных средств и данных. Существенно, что техническая информация все время обновляется в течение жизненного цикла ИС.
Руководящие указания описываемого стандарта структурированы, что позволяет поставить в соответствие этапам развития и совершенствования проекта необходимую документацию. Основные этапы проекта последовательны во времени, но отдельные этапы и подготовка некоторых документов перекрываются; например подготовку руководств поддержки системы следует начать на этапе проектирования и внедрения ИС. У различных приложений варьируется как количество этапов, так и количество документов; в руководстве дан список наиболее общих компонент в генерируемых документах на каждом этапе процесса создания и совершенствования системы.
Технический отчет ISO 9294 представляет руководство по документированию ПС для руководителей, отвечающих за создание программной продукции. Руководство предназначено для помощи в управлении разработкой и эффективном документировании программных проектов. Отчет отражает рекомендуемые стратегии, стандарты, процедуры, ресурсы и планы, которыми должны заниматься сами руководители в целях эффективного управления документированием ПС и БД. Охвачены все типы программной документации на всех стадиях жизненного цикла ИС. Рекомендуемые принципы управления документированием ПС и БД для проектов любого объема и сложности одни и те же.
Детализированы функции документации, обеспечивающей: информацию для управления разработкой ИС; связь между задачами в комплексе программ; достижение заданного качества программ; сопровождение программных средств; исторические справки. В процессе установление стратегии, стандартов и руководств по документированию рекомендуется осуществлять:
· выбор модели жизненного цикла ПС и БД;
· определение типов и содержания каждого документа;
· определение необходимого качества документа;
· определение форматов и системы обозначения документов;
· установление процедур документирования.
Обращается внимание на необходимость тщательного распределения ресурсов для документирования: персонала; технических средств; финансов, а также на планирование документирования.
Стандарт ISO 9127 отражает пользовательскую документацию и описание применения, которые должны поставляться на рынок вместе с потребительским пакетом ПС. Для защиты собственных интересов разработчики обычно не публикуют для потребителей системную и программную документацию, требуемую для сопровождения и улучшения ПС, которая детально описывает содержимое программ. Производители выпускают данную документацию отдельно для того, чтобы адекватно сопровождать ПС. Потребительские пакеты ПС – это готовые пакеты, предназначенные для продажи потребителю. Обычно ПС продается предварительно упакованным со своей пользовательской документацией. Стандарт не дает руководства о том, как, в какой форме или в каком стиле должна быть представлена информация, а только предлагает порядок подачи информации и расположение содержимого информации в документации отдельного пакета.
Пользовательская документация – инструкция по эксплуатации содержит описание, в котором заключена вся информация, необходимая пользователю для установки, запуска и применения ПС. Обычно эта документация представляет собой одно или более руководств, заключенных вместе с носителями ПС внутри упаковки. В результате пользователи не могут ознакомиться с руководством до тех пор, пока пакет не куплен. Состав пользовательской документации описан в разделе 1 данного стандарта.
Описание целей и области применения публикуется на внешней упаковке пакета ПС. Его задачей является дать возможность будущему покупателю оценить применимость ПС к своим потребностям. Структура этой информации представлена в разделе 2 данного стандарта.
Стандарт ANSI/IEEE 1063 содержит минимальные требования к структуре и содержанию комплекта документов для пользователей программных продуктов. Стандарт ориентирован на документы, применяемые при инсталляции, эксплуатации и поставке ПС любого размера и назначения, но без права изменения программ. Он не применим для технологической документации, используемой при проектировании, разработке, тестировании, испытаниях и сопровождении ПС, а также для оформления коммерческих пакетов прикладных программ (см.ISO 9127). Использование стандарта не должно препятствовать применению более строгих и широких требований к документам, а также собственных стандартов организаций по стилю изложения документов.
Стандарт состоит из семи разделов. В первых двух разделах представлено назначение, ограничения для применения и определения основных терминов. В третьем разделе рекомендуется начинать планирование разработки документации с определения:
· потенциальных пользователей и их взаимодействия с документами;
· комплектации и ориентации каждого документа на определенную сферу применения;
· способов использования документов:
· инструктивных для обучения, применению и основным операциям по эксплуатации, диагностике и инсталляции ПС
· и справочных, детально представляющих всю необходимую информацию при применении и функционировании программ.
В четвертом разделе представлены требования составу (структуре) единого пользовательского документа. Две таблицы, отражают рекомендуемую структуру документа и варианты его модификации. В первой таблице перечислены названия подразделов, рекомендуемого типового пользовательского документа на ПС. Во второй таблице состав этих подразделов адаптирован для документирования небольших, относительно простых программ и для сложных комплексов программ с многотомной документацией.
Пятый раздел посвящен подробному изложению требований и рекомендаций к содержанию каждого из 12-ти подразделов пользовательского документа на программное средство. Начинается документ с титульного листа, оформляемого по правилам фирмы с учетом требований заказчика. Второй подраздел должен содержать ограничения на применение документа и указания на авторские права на программный продукт и пользовательский документ. Далее должны быть представлены гарантии и обязательства по контракту, а также условия отказа от них. В четвертом подразделе рекомендуется изложить перечень разделов документа, а в пятом — перечень иллюстраций (рисунков, таблиц и схем) с указанием страницы текста описания, где они используются. В предисловии (шестой подраздел) следует указать: предлагаемый уровень квалификации и предшествующее обучение пользователей; аппаратную и операционную среду, которой соответствует применение данной версии ПС и документа; назначение документа; стилистические особенности описания; взаимодействие с другими документами; отчетность о дефектах.
Седьмой подраздел пятого раздела – основной и назван "тело" документа, рекомендуется подготавливать из двух частей: учебно-методической и справочно-рекомендующей. В первой части должны быть изложены теоретические основы комплекса программ, решаете задачи, технические и административные операции для их запуска, предостережения и предупреждения, метод решения каждой задачи, их взаимодействие и ограничения. Вторая часть должна содержать конкретные рекомендации и подробные инструкции по применению данного ПС. Должны быть детально изложены все исходные данные, необходимые для корректного функционирования программ, информация для их контроля, рекомендации как приостановить исполнение и провести рестарт программ, регистрация окончание исполнения программы и состав результатов.
Последние пять подразделов должны содержать: предупреждения о возможных ошибках и дефектах освоения; приложения – детальные сведения о форматах исходных и результирующих данных, структуре файлов и экранов; библиографию; глоссарий и индекс.
Шестой раздел стандарта содержит общие методические требования к представлению документа пользователя: методику освещения материала; рекомендации по составу и плотности текста каждого раздела; терминологические рекомендации, а также по отражено взаимосвязи частей материала. В седьмом разделе стандарта приведена библиография.
[1] Адаптация стандартов к национальным и отраслевым условиям является общепризнанной мировой практикой в области стандартизации, правила подобной адаптации предусмотрены в самих международных стандартах.
[2] Рамочные стандарты задают общие требования к реализации процессов, связанных с разработкой и поддержкой жизненного цикла систем. Они обычно используются как методологическая основа для организации этих процессов с необходимой конкретизацией для каждого данного предприятия или области деятельности.
[3] Работа международного сообщества в этом направлении активно ведется.
[4] Номера процессов на рисунке соответствуют номерам разделов документа
[5] http://www.interface.ru/home.asp?artId=3293