Документирование программного обеспечения в соответствии с Единой системой программной документации.
Документирование программного обеспечения– важный этап в процессе создания и эксплуатации программного обеспечения, так как пользователь начинает свое знакомство с программным продуктом с программной документации. Для чего предназначен программный продукт, как установить программный продукт, как начать с ним работать – это первые вопросы, на которые должна отвечать программная документация.
Вопросы, связанные с документированием программных средств, решаются с помощью отечественных и международных стандартов, включающих стандарты на виды программной документации, структуру программных документов, требования к оформлению программных документов.
Основу отечественной нормативной базы в области документирования программных средств составляет комплекс стандартов Единой системы программной документации (ЕСПД).
Единая система программной документации- комплекс национальных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации. Стандарты ЕСПД в основном охватывают ту часть документации, которая создается в процессе разработки программных средств. Эти стандарты носят рекомендательный характер. В соответствии с Законом РФ «О техническом регулировании» они становятся обязательными на контрактной основе, то есть при ссылке на них в договоре на разработку или поставку программных средств.
В состав ЕСПД входят:
-
основополагающие и организационно-методические стандарты;
-
стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;
-
стандарты, обеспечивающие автоматизацию разработки программных документов.
Несмотря на то, что большая часть стандартов ЕСПД морально устарела и нуждается в полном пересмотре на основе стандарта ИСО/МЭК 12207-99 на процессы жизненного цикла программных средств, многие стандарты могут применяться в практике документирования программных средств. Эта позиция основана на следующем:
-
стандарты ЕСПД вносят элемент упорядочения в процессе документирования программных средств;
-
предусмотренный стандартами ЕСПД состав программных документов может быть изменен в конкретных проектах;
-
стандарты ЕСПД позволяют мобильно изменять структуру и содержание установленных видов программных документов, исходя из требований заказчика и пользователя.
Перечень документов ЕСПД обширен. Одним из основных стандартов является ГОСТ 19.101-77ЕСПД. Виды программ и программных документов.
В Российской Федерации действует ряд стандартов на документирование программного обеспечения, разработанных на основе прямого применения международных стандартов ИСО и МЭК.
ГОСТ Р ИСО/МЭК ТО 9294-93 Информационная технология. Руководство по управлению документированием программного обеспечения. Стандарт полностью соответствует стандарту ISO/IEC 9294:1990и устанавливает рекомендации по эффективному управлению документированием программных средств для руководителей, отвечающих за их создание. Целью стандарта является оказание помощи в определении стратегии документирования программных средств, выборе стандартов по документированию, выборе процедур документирования, определении необходимых ресурсов, составлении планов документирования.
ГОСТ Р ИСО/МЭК 12119-2000. Информационная технология. Пакеты программ. Требования к качеству и тестирование. В этом стандарте установлены требования к качеству пакетов программ и инструкции по их испытаниям на соответствие заданным требованиям. Стандарт определяет требования к качеству и испытаниям, определяет требования к описанию продукта, к пользовательской документации, программам и данным. Предполагается, что документ «Описание продукта» должен помочь пользователю или потенциальному покупателю оценить данный продукт, а пользовательская документация должна содержать всю информацию, необходимую для применения продукта.
В данном стандарте требования к качеству продукта рассматриваются с точки зрения описания реальных свойств продукта в «Описании продукта» и пользовательской документации. Требования к программам и данным в основном сводятся к утверждению необходимости соответствия реальных свойств продукта свойствам, объявленным в документации. Таким образом, стандарт определяет исходные требования к продукту:
-
требования, согласно которым каждый пакет должен содержать описание продукта и документацию пользователя;
-
требования к описанию продукта; в частности, требование, согласно которому описание продукта должно содержать конкретную информацию, а все приводимые в нем формулировки должны быть проверяемыми и корректными;
-
требования к документации пользователя;
-
требования к любым программам и данным, входящим в состав пакета программ.
ГОСТ Р ИСО 9127-94. Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов. Стандарт полностью соответствует международному стандарту ИСО 9127:1989. В контексте настоящего стандарта под потребительским программным пакетом понимается «программная продукция, спроектированная и продаваемая для выполнения определенных функций; программа и соответствующая ей документация, упакованные для продажи как единое целое». Документация пользователя- документация, которая обеспечивает конечного пользователя информацией по установке и эксплуатации программного пакета. Обычно эту документацию представляют в виде одного или нескольких руководств, вкладываемых вместе с программным средством внутрь упаковки. Под информацией на упаковке понимают информацию, воспроизводимую на внешней упаковке программного пакета. Ее целью является предоставление потенциальным покупателям возможности принять решение о применимости данного программного средства в соответствии с их потребностями.