Тема 5. Документирование ПО (семинар)

1. Принципы и стандарты документирования программного обеспечения.

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

Основу отечественной нормативной базы в области документирования ПС составляет комплекс стандартов Единой системы программной документации (ЕСПД). Основная и большая часть комплекса ЕСПД была разработана в 70-е и 80-е годы 20 века.

В РФ действует ряд стандартов в части документирования ПС, разработанных на основе прямого применения международных стандартов ИСО. Это самые «свежие» по времени принятия стандарты. Некоторые из них напрямую адресованы руководителям проекта.

1) ГОСТ Р ИСО/МЭК 9294-93. Информационная технология. Руководство по управлению документированием программного обеспечения. Стандарт полностью соответствует международному стандарту ИСО/МЭК 9294:1990 и устанавливает рекомендации по эффективному управлению документированием ПС для руководителей, отвечающих за их создание. Целью стандарта - оказание помощи в определении стратегии документирования ПС; выборе стандартов по документированию; выборе процедур документирования, определении необходимых ресурсов; составлении планов документирования.

Важно!!! 2) ГОСТ Р ИСО/МЭК 9126-93. Информационная технология. Оценка программной продукции. Характеристики качества и руководства по их применению. Стандарт полностью соответствует международному стандарту ИСО/МЭК 9126:1991. В его контексте под характеристикой качества понимается «набор свойств (атрибутов) программной продукции, по которым ее качество описывается и оценивается».

Стандарт определяет 6 комплексных характеристик, которые с минимальным дублированием описывают качество ПС (ПО, программной продукции):

• функциональные возможности;

• надежность;

• практичность;

• эффективность;

• сопровождаемость;

• мобильность.

Эти характеристики образуют основу для дальнейшего уточнения и описания качества ПС.

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

В контексте стандарта под потребительским программным пакетом (ПП) понимается «программная продукция, спроектированная и продаваемая для выполнения определенных функций; программа и соответствующая ей документация, упакованные для продажи как единое целое».

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

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

4) ГОСТ Р ИСО/МЭК 8631-94. Информационная технология. Программные конструктивы и условные обозначения для их представления. Описывает представление процедурных алгоритмов.

Пока нет лучшего, можно извлекать пользу и из тех стандартов ЕСПД, которые приняты еще около 20 лет назад. Но ясно, что ориентироваться надо на современные стандарты.

Практики сами переводят и используют в своих проектах современные стандарты на организацию ЖЦ ПС и их документирование. Недостатки: разные переводы и адаптации стандартов, сделанные разными разработчиками и заказчиками, будут отличаться массой деталей. Эти отличия неизбежно касаются не только наименований, но и их содержательных определений, вводимых и используемых в стандартах. Т. о., неизбежно постоянное возникновение путаницы, а это прямо противоположно целям стандартов.

Важно!!! 5) ГОСТ Р ИСО/МЭК 12119:1994 (2000). Информационная технология. Пакеты программных средств. Требования к качеству и испытания. В этом стандарте установлены требования к качеству пакетов программ и инструкции по их испытаниям на соответствие заданным требованиям.