Документирование ПО Совокупные затраты на документирование крупных программных продуктов могут достигать 20 – 30% от общей трудоемкости проекта

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

ГОСТ 19.ХХХ Пояснительная записка Спецификация Ведомость держателей подлинников Текст программы Описание программы. Описание языка Ведомость эксплуатационных документов Формуляр Описание применения Руководство системного программиста Руководство программиста Руководство оператора Руководство по техническому обслуживанию Методика испытаний Прочие документы

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

технические характеристики постановка задачи; описание применяемых математических методов; описание алгоритмов функционирования программы; описание организации входных и выходных данных; описание состава технических и программных средств.

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

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

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

Стандарты Американский Национальный институт стандартов (ANSI). Институт инженеров по электронике и радиоэлектронике IEEE (США). Международная организация по стандартизации (ISO). ЕС предписывает следование стандартам ISO любой организации, имеющей дело со странами Евросоюза. Институт технологий программного обеспечения SEI, учрежденный Министерством обороны США.

Наиболее признанные и применяемые стандарты

Стандарт ANSI/IEEE на Документацию по тестированию программного обеспечения (STD Software Test Documentation), заново подтвержденный в 1991 году, состоит из следующих разделов: Введение План тестирования Тестируемые элементы, границы, подход, ресурсы, расписание, персонал. Проект тестирования Тестируемые элементы, подход, план в подробностях. Тестовые варианты Наборы входных данных и событий. Тестовые процедуры Шаги настройки и выполнения тестовых вариантов. Отчет о проведении тестирования элементов Тестируемый элемент, физическое местоположение результатов, ответственный за проведение тестов. Журнал испытаний Хронологическая запись, физическое местоположение теста, название теста. Отчет о происшествиях во время тестирования. Документирование любого события, имевшего место во время тестирования, требующего дальнейших расследований. Итоговый отчет о тестировании Итог всего перечисленного.

Основы административного управления жизненным циклом (CMMI:2003, ISO 9000:2000, ISO 15504:1-9) 1. Ориентация предприятия- разработчика на потребителя-заказчика 2. Лидерство-руководство. 3. Вовлечение персонала. 4. Процессный подход. 5. Системный подход к административному управлению. 6. Постоянное усовершенствование. 7. Подход к принятию решений основанный на фактах. 8. Взаимовыгодные отношения с поставщиками.

Документ описания требований Существует несколько способов: стандарт IEEE , –результат: спецификация требований к программному обеспечению (SRS – Software Requirement Specification), включающая общее описание (С-требования или требования заказчика) конкретные требования (D-требования или требования разработчика); стандарт ГОСТ (ГОСТ ), – результат: техническое задание (С-требования или требования заказчика) функциональная спецификация (D-требования или требования разработчика).

Содержание документа описания требований стандарт IEEE Введени 1.1.Цель 1.2.Область применения 1.3.Определения, термины и сокращения 1.4.Ссылки 1.5.Обзор 2.Общее описание 2.1.Перспективы продукта Системные интерфейсы Пользовательские интерфейсы Аппаратные интерфейсы Программные интерфейсы Коммуникационные интерфейсы Ограничения по памяти Операции Требования по адаптации 2.2.Функции продукта 2.3.Пользовательские характеристики 2.4.Ограничения 2.5.Предположения и зависимости 2.6.Распределение требований 3.Конкретные требования 4.Сопровождающая информация