ГОССТАНДАРТ РОССИИ - ИНФОРМАЦИОННАЯ ТЕХНОЛОГИЯ. РУКОВОДСТВО ПО УПРАВЛЕНИЮ ДОКУМЕНТИРОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ

1. РАЗРАБОТАН И ВНЕСЕН Техническим комитетом по стандартизации ТК 22 «Информационная технология»

2. УТВЕРЖДЕН И ВВЕДЕН В ДЕЙСТВИЕ Постановлением Госстандарта России от 20.12.93 № 260

Стандарт подготовлен на основе применения аутентичного текста технических рекомендаций ИСО/МЭК ТО 9294-90 «Информационная технология. Руководство по управлению документированием программного обеспечения»

3. ВВЕДЕН ВПЕРВЫЕ

Настоящий стандарт не может быть полностью или частично воспроизведен, тиражирован и распространен в качестве официального издания без разрешения Госстандарта России

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

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

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

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

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

ИСО 2382-84 Обработка данных. Словарь. Часть 1: Основные термины

ИСО 6592-85 Обработка информации. Руководство по документированию прикладных систем на основе ЭВМ.

ИСО 9127-88 Системы обработки информации. Документация пользователя и упаковочная информация для потребительских пакетов программ.

Примечание – До прямого применения данных международных стандартов в качестве государственных стандартов Российской Федерации они могут быть получены по запросам из ВНИИКИ Госстандарта России.

В настоящем стандарте применяют следующие термины.

3.1 документ- Уникально обозначенный блок информации для использования человеком, такой как отчет, спецификация, руководство или книга.

3.2 документация- Набор из одного или более связанных документов.

3.3 программная продукция- Результат процесса разработки программного обеспечения, т. е. программное обеспечение, выпускаемое для использования.

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

Эффективность выполнения руководящей роли можно рассматривать как основанную на трех элементах:

1) руководящая обязанность по документированию.

Данная обязанность требует признания того, что программная документация важна и что ее следует планировать, описывать, проверять, утверждать, выпускать, распространять и сопровождать;

2) руководящая поддержка обязанностей персонала по документированию.

Для этого требуется руководство и стимулирование персонала при проведении требуемого документирования и обеспечение его ресурсами для содействия в данной работе;

3) признаки руководящих обязанностей и поддержки.

Для этого требуется обеспечить:

а) опубликованные официальные отчеты о стратегии документирования;

б) стандарты и руководства, определяющие все аспекты документирования программного обеспечения;

в) опубликованные процедуры документирования;

г) выделение соответствующих ресурсов для документирования;

д) планирование документирования, осуществляемое как неотъемлемая часть процесса разработки программного обеспечения;

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

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

Программную документацию можно рассматривать как имеющую шесть основных функций:

1) информация для управления (см. 5.1);

2) связь между задачами (см. 5.2);

3) обеспечение качества (см. 5.3);

4) инструкции и справки (см. 5.4);

5) сопровождение программного обеспечения (см. 5.5);

6) исторические справки (см. 5.6).

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

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

В типовом варианте:

специалисты в предметной областиначинают проект;

аналитикиформулируют требования к системе;

проектировщики разрабатывают системный и программный проекты;

специалисты по изданиямсоздают пользовательскую документацию в соответствии со стратегией и стандартами по документированию;

специалисты по обеспечению качестваи ревизорыоценивают общую полноту и качество функционирования программного обеспечения;

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

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

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