Установление стратегии документирования

Функции программной документации

Определения

Нормативные ссылки

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

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

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

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

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

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

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

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

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

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

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

3) обеспечение качества;

4) инструкции и справки;

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

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

Стратегия должна поддерживать основные элементы эффективного документирования: