Международный стандарт iso/iec 12207: 1995-08-01

Первая редакция ISO12207 подготовлена в 1995 году объединенным техническим комитетом ISO/IEC JTC1 "Информационные технологии, подкомитет SC7, проектирование программного обеспечения".

По определению, ISO12207 - базовый стандарт процессов ЖЦ ПО, ориентированный на различные (любые!) виды ПО и типы проектов АС, куда ПО входит как часть. Стандарт определяет стратегию и общий порядок в создании и эксплуатации ПО, он охватывает ЖЦ ПО от концептуализации идей до завершения ЖЦ.

2. Основное понятие , виды и содержание программных документов документации

К программным документам относятся документы, содержащие сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ. 

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

Ведомость держателей подлинников (код вида документа - 05) - содержит перечень предприятий, на которых хранят подлинники программных документов. Выполняется на стадии рабочего проекта. Необходимость составления документа на этапе утверждения технического задания (по согласованию). 

Текст программы (код вида документа - 12) - содержит запись программы с необходимыми комментариями. Выполняется на стадии рабочего проекта. Необходимость - по согласованию. 

Описание программы (код вида документа - 13) - содержит сведения о логической структуре и функционировании программы. Выполняется на стадии рабочего проекта. Необходимость - по согласованию. 

Программа и методика испытаний (код вида документа - 51) - содержит требования, подлежащие проверке при испытаниях программы, а также порядок и методы их контроля. Выполняется на стадии рабочего проекта. Необходимость - по согласованию. 

Техническое задание - содержит назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний. Выполняется на стадии технического задания и является обязательным документом для комплекса. Необходимость составления технических заданий на компоненты определяется по согласованию с заказчиком. 

Пояснительная записка (код вида документа - 81) - содержит схему алгоритма, общее описание алгоритма и /или функционирования программы, а также обоснование принятых технических и технико-экономических решений. Выполняется на стадии эскизного и технического проектов. Необходимость - по согласованию. 

Эксплуатационные документы - содержит сведения для обеспечения функционирования и эксплуатации программы. Выполняются на стадии рабочего проекта. Необходимость - по согласованию для каждого документа отдельно. 

Лекция №3 Тема виды документации
3.Общие требования к программным документам

3.1..Требования к содержанию и оформлению спецификации

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

комплексы; 

компоненты. 

3.2.Требования к содержанию и оформлению текста программы

Требования к оформлению текста программы достаточно просты и естественны для грамотного программиста. Основное, чем требуется руководствоваться при создании этого документа – это то, что текст программы должен быть удобочитаемым.

По-прежнему обязательным является составление информационной части - аннотации и содержания.

Основная часть документа должна состоять из текстов одного или нескольких разделов, которым даны наименования.

Текст каждого программного файла начинается с "шапки", в которой указывается:

-        наименование программы,

-        автор,

-       дата создания программы,

-       номер версии,

-        дата последней модификации.

Обязательными являются комментарии, а также строгое соблюдение правил отступа. Помните, оправдать можно даже неумение создавать программную документацию. А некрасивый текст программы – никогда. Ссылки на то, что этот текст понятен самому автору, всерьез не воспринимаются. Тексты программ должно быть не стыдно давать читать другим людям.