Оформление программной документации
Техническое задание на разработку программного продукта
3.2. Описание программы
3.3. Текст программы
Программа и методика испытаний
3.5. Требования к программным документам, выполненным печатным способом
Приложение. Форма технического задания на разработку программного продукта (изделия, модели)
Введение. Общие сведения о Единой системе программной документации (ЕСПД).
Единая система программной документации – это комплекс государственных стандартов, устанавливающих взаимоувязанные правила разработки, оформления и обращения программ и программной документации.
Стандарты ЕСПД определяют общие положения и основополагающие стандарты, правила выполнения документации разработки, правила выполнения документации изготовления, правила выполнения документации сопровождения, правила выполнения эксплуатационной документации, правила обращения программной документации и прочие стандарты.
В состав ЕСПД входят:
· основополагающие и организационно-методические стандарты;
· стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;
· стандарты, обеспечивающие автоматизацию разработки программных документов.
В перечень документов ЕСПД входят следующие ГОСТы:
ГОСТ 19.001-77 ЕСПД. Общие положения.
ГОСТ 19.101-77 ЕСПД. Виды программ и программных документов (переиздан в ноябре 1987г с изм.).
ГОСТ 19.102-77 ЕСПД. Стадии разработки.
ГОСТ 19.103-77 ЕСПД. Обозначение программ и программных документов.
ГОСТ 19.104-78 ЕСПД. Основные надписи.
ГОСТ 19.105-78 ЕСПД. Общие требования к программным документам.
ГОСТ 19.106-78 ЕСПД. Требования к программным документам, выполненным печатным способом.
ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.
ГОСТ 19.202-78 ЕСПД. Спецификация. Требования к содержанию и оформлению.
ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний.
ГОСТ 19.401-78 ЕСПД. Текст программы. Требования к содержанию и оформлению.
ГОСТ 19.402-78 ЕСПД. Описание программы.
ГОСТ 19.404-79 ЕСПД. Пояснительная записка. Требования к содержанию и оформлению.
ГОСТ 19.501-78 ЕСПД. Формуляр. Требования к содержанию и оформлению.
ГОСТ 19.502-78 ЕСПД. Описание применения. Требования к содержанию и оформлению.
ГОСТ 19.503-79 ЕСПД. Руководство системного программиста. Требования к содержанию и оформлению.
ГОСТ 19.504-79 ЕСПД. Руководство программиста.
ГОСТ 19.505-79 ЕСПД. Руководство оператора.
ГОСТ 19.506-79 ЕСПД. Описание языка.
ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
ГОСТ 19.604-78 ЕСПД. Правила внесения изменений в программные документы, выполняемые печатным способом.
ГОСТ 19.701-90 ЕСПД. Схемы алгоритмов, программ, данных и систем. Условные обозначения и правила выполнения.
ГОСТ 19.781-90. Обеспечение систем обработки информации программное.
К другим стандартам в области документирования программных систем (ПС) относятся:
ГОСТ 34.602-89 Информационная технология. Комплекс стандартов на автоматизированные системы. Техническое задание на создание автоматизированной системы.
ГОСТ 34.601-90 Информационная технология. Комплекс стандартов на автоматизированные системы. Автоматизированной системы. Стадии создания.
ГОСТ Р ИСО/МЭК ТО 12182-2002 Информационная технология. Классификация программных средств.
ГОСТ Р ИСО/МЭК 12207-99 Информационная технология. Процессы жизненного цикла программных средств.
ГОСТ Р ИСО/МЭК 14764-2002 Информационная технология. Сопровождение программных средств.
ГОСТ Р ИСО/МЭК 15026-2002 Информационная технология. Уровни целостности систем и программных средств.
ГОСТ Р ИСО/МЭК ТО 15271-2002 Информационная технология. Руководство по применению ГОСТ Р ИСО/МЭК 12207-99.
ГОСТ Р ИСО/МЭК 15910-2002 Информационная технология. Процесс создания документации пользователя программного средства.
Международные стандарты ISO/IEC:
ISO/IEC 12207:2008 System and software engineering – Software life cycle processes.
ISO/IEC 15288:2008 System and software engineering – System life cycle processes.
IEEE 830-1998 Recommended practice for software requirements specifications.
IEEE 1233-1998 Guide for developing system requirements specifications.
IEEE 1016-1998 Recommended Practice for Software Design Descriptions.
ISO/IEC 42010 IEEE Std 1471-2000 System and software engineering – Recommended practice for architectural description of software-intensive systems.
ISO 9001:2000 Quality management systems – Requirements.
ISO/IEC 90003:2004 Software engineering – Guidelines for the application of ISO 9001:2000 to computer software.
ISO/IEC TR 90005:2008 Software engineering – Guidelines for the application of ISO 9001:2000 to system life cycle processes.
ISO/IEC 9126-1:2001 Software engineering – Product quality – Part 1: Quality model.
ISO/IEC 9126-2:2003 Software engineering – Product quality – Part 2: External metrics.
ISO/IEC 9126-3:2003 Software engineering – Product quality – Part 3: Internal metrics.
ISO/IEC 9126-4:2004 Software engineering – Product quality – Part 4: Quality in use metrics.
ISO/IEC 25051:2006 Software engineering – Software product Quality Requirements and Evaluation (SQuaRE) – Requirements for quality of Commercial Off-The-Shelf (COTS) software product and instructions for testing.
IEEE 829-1998 Standard for Software Test Documentation.
IEEE 829-2008 Standard for Software and System Test Documentation.
IEEE 1008-1987 (R1993, R2002) Standard for Software Unit Testing.
ISO/IEC 14598-1:1999 Information technology – Software product evaluation – Part 1: General overview.
ISO/IEC 14598-2:2000 Software engineering – Product evaluation – Part 2: Planning and management.
ISO/IEC 14598-3:2000 Software engineering – Product evaluation – Part 3: Process for developers.
ISO/IEC 14598-4:1999 Software engineering – Product evaluation – Part 4: Process for acquirers.
ISO/IEC 14598-5:1998 Information technology – Software product evaluation – Part 5: Process for evaluators.
ISO/IEC 14598-6:2001 Software engineering – Product evaluation – Part 6: Documentation of evaluation modules.
Как видно, основная часть комплекса отечественных стандартов ЕСПД была разработана в 70-е и 80-е годы. Частично эти стандартны морально устарели, к тому же они не лишены некоторых недостатков: во-первых, в них не отражены некоторые современные тенденции оформления программ и программной документации, во-вторых, в этих стандартах встречается многократное дублирование фрагментов программной документации. Тем не менее, за неимением лучшего ориентироваться приходится именно на них.
Стандарты ЕСПД упорядочивают процесс документирования программных систем. При этом стандарты ЕСПД, исходя из требований Заказчика, позволяют вносить в комплект документации на программные системы некоторые изменения как в структуре, так и в содержании установленных видов программных документов.
Кроме того, перечисленные выше стандарты носят рекомендательный характер и становятся обязательными на контрактной основе – т.е. при ссылке на них в договоре на разработку или поставку программных средств.
При рассмотрении правил составления программной документации, необходимо иметь ввиду, что каждый документ желательно предварять некоторым введением.
Во введении приводятся общие слова об актуальности, необходимости и значимости и т.п. разрабатываемого программного продукта.