Правила оформления программной документации по ГОСТ

Названия документов — только ПРОПИСНЫМИ

Согласно ГОСТ 19.101–77, ГОСТ 2.105–95 и ГОСТ 19.106–78, на титульном листе и в оглавлении официальные наименования документа пишутся ПРОПИСНЫМИ БУКВАМИ без кавычек и дополнительных акцентов:

Примеры:

• ТЕХНИЧЕСКОЕ ЗАДАНИЕ

• ПРОГРАММА И МЕТОДИКА ИСПЫТАНИЙ

• РУКОВОДСТВО ПОЛЬЗОВАТЕЛЯ

• ОПИСАНИЕ ПРОГРАММЫ

• ФОРМУЛЯР ПРОГРАММЫ

Это требование распространяется только на заголовки титульных страниц и оглавлений.

Подзаголовки и уточнения — строчными буквами

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

Примеры:

• РУКОВОДСТВО АДМИНИСТРАТОРА

  Инструкция по установке серверной части

• ПРОГРАММА И МЕТОДИКА ИСПЫТАНИЙ. Программный компонент X версии 1.2

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

Упоминание других документов в теле текста

Согласно п. 6.2.3 ГОСТ 2.105–95 и ГОСТ 19.101–77, при упоминании других документов в тексте необходимо использовать кавычки и обычное написание (первая буква заглавная, остальные — строчные).

Правильно:

• В соответствии с «Техническим проектом»…

• См. «Программу и методику испытаний»…

Исключение: если наименования указаны в списке создаваемых документов (например, в техническом задании), можно использовать КАПС для визуального выделения — но только в списках, не в тексте.

Оформление приложений

Согласно ГОСТ 2.105–95 (п. 6.6) и ГОСТ 19.106–78:

• Приложения, входящие в состав документа, не требуют отдельного титульного листа.

• Они оформляются под заголовком вида – примеры:

  • Приложение А. Инструкция по установке

  • Приложение Б. Таблица настроек доступа

Если приложение публикуется отдельным файлом (например, в виде PDF), допускается добавить титульный лист, на котором указывается:

• Название основного документа (например, ТЕХНИЧЕСКОЕ ЗАДАНИЕ);

• Название приложения (например, Приложение А. Инструкция по установке);

• Название организации, номер версии, дата и пр.

Перечень создаваемых документов в составе ТЗ

Согласно ГОСТ 34.602–89 (раздел 7), перечень документов в составе проектной документации указывается без кавычек, без КАПС и без форматирования. Это — нормативно установленная форма.

Пример формулировки:

В составе проектной документации должны быть разработаны:

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