2.1. Стандарты, регламентирующие документирование проектов сложных программных средств

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

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

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

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

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

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

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

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

Стандартизированные форматы – шаблоны документов важны для контроля качества документов, для читаемости документов и для облегчения их сопровождения. Форматы документов могут различаться от проекта к проекту. Они зависят от таких факторов, как объем проекта, аудитория, для которой предназначены документы, количество установленных стадий и бюджет документирования. В проектируемых форматах должно быть учтено будут ли документы переводиться для международного распространения.

Основными ресурсами в стандарте, для документирования выделяются: персонал; инструментальные средства; финансирование.

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

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

- уточнить области применения используемого стандарта или ПС;

- определить, выбрать стандарты и шаблоны документов, применимые к конкретному проекту ПС;

-определить классификационные характеристики новых стандартов.

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

В стандарте ISO 12207 документированию посвящен специальный раздел 6.1 в группе вспомогательных процессов. Кроме того, почти все процессы и работы основного, пятого раздела стандарта, представляющего этапы и работы жизненного цикла ПС, отражают конкретные требования к документированию соответствующих работ. Специальный раздел стандарта по документированию ПС имеет следующее содержание (c небольшими сокращениями нумерации).

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

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

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

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

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

Стандарт ГОСТ Р 51904 регламентирует документы, которые создаются в течение всего жизненного цикла ПС. Эти документы позволяют реализовать процессы и модификацию программного средства.