Виды программных документов

К программным относят документы, содержащие сведения, необходимые для разработки, сопровождения и эксплуатации про­граммного обеспечения. Документирование программного обеспе­чения осуществляется в соответствии с Единой системой про­граммной документации (ГОСТ 19.ХХХ). Так, ГОСТ 19.101—77 устанавливает виды программных документов для программного обеспечения различных типов. Ниже перечислены основные про­граммные документы по этому стандарту и указано, какую инфор­мацию они должны содержать.

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

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

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

 

Описание программы (код вида документа — 13) должно со­держать сведения о логической структуре и функционировании программы.

Ведомость эксплуатационных документов (код вида докумен­та — 20) должна содержать перечень эксплуатационных доку­ментов на программу, к которым относятся документы с кодами 30, 31, 32, 33, 34, 35, 46. Необходимость этого документа также определяется на этапе разработки и утверждения технического задания.

Формуляр (код вида документа — 30) должен содержать ос­новные характеристики программного обеспечения, комплект­ность и сведения об эксплуатации программы.

Описание применения (код вида документа — 31) должно со­держать сведения о назначении программного обеспечения, об­ласти применения, применяемых методах, классе решаемых за­дач, ограничениях для применения, минимальной конфигура­ции технических средств.

Руководство системного программиста (код вида докумен­та — 32) должно содержать сведения для проверки, обеспечения функционирования и настройки программы на условия кон­кретного применения.

Руководство программиста (код вида документа — 33) долж­но содержать сведения для эксплуатации программного обеспе­чения.

Руководство оператора (код вида документа — 34) должно содержать сведения для обеспечения процедуры общения опера­тора с вычислительной системой в процессе выполнения про­граммного обеспечения.

Описание языка (код вида документа — 35) должно содержать описание синтаксиса и семантики языка.

Руководство по техническому обслуживанию (код вида доку­мента — 46) должно содержать сведения для применения тестовых и диагностических программ при обслуживании техниче­ских средств.

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

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

Составляется на стадии эскизного и технического проектов.

Прочие документы (коды вида документа — 90—99) могут составляться на любых стадиях разработки, т. е. на стадиях эс­кизного, технического и рабочего проектов.

Содержание документов сопровождения