6.4
Содержание
Стандарт ГОСТ Р 2.105-2019 рекомендует включать раздел
«Содержание» в текстовой документ, объем которого превышает 24 листа.
Однако с точки зрения технического писателя, составителя или
разработчика технического документа, составление раздела «Содержание» перед
началом работы над документом является обязательным, даже если этот раздел не
будет включен в окончательную редакцию документа.
Наличие раздела «Содержание» «под рукой», обеспечивает
разработчику общее представления о структуре документа, служит своеобразным
путеводителем, помогающим ориентироваться в документе в процессе работе над ним
и своевременно учитывать все изменения в нем.
Такой
«черновик» раздела «Содержание» выглядит совсем по-другому, чем он описан в
стандарте ГОСТ Р 2.105-2019.
В
процессе работы над документом его целесообразно оформлять в виде отдельного
файла, в который разработчик включает перечень рисунков, таблиц, формул, а
также задач, примеров и др. (при их наличии в документе).
На рисунке 21 приведен пример такого файла для раздела
«Содержание» данного справочного пособия.
|
Введение 1 Децимальный номер Рисунок 1 –
Структура децимального номера по ГОСТ 2.201-80 Рисунок 2 – Ошибка
в присвоении децимального номера Рисунок 3 – Код
документа по ГОСТ 2.201-80 Рисунок 4 -
Структура обозначения программы и спецификации по ГОСТ19.103-77 Рисунок 5 Структура
обозначения других программных документов Задача 1 Рисунок 6 -
Структура обозначения документов по ГОСТ 34.201-2000 Задача 2 2 Титульный лист Рисунок 7 -
Титульный лист технических условий с внешними рамками
по ГОСТ 2.301-68 Рисунок 8 -
Продолжение титульного листа без внешних рамок
по ГОСТ 2.301-68 Рисунок 9 - Пример
оформления титульного листа с названием изделия
во множественном числе Рисунок 10 -
Основная надпись по ГОСТ 2.104-68 Рисунок 11 -
Образец титульной части программного документа Задача 3 |
|
Рисунок
21 Пример вспомогательного файла «Содержание», созданного при подготовке
этого справочника |
О том, как оформляют раздел «Содержание» при включении его в
текст документа подробно рассказано в разделе 6.2 стандарта
ГОСТ Р 2.105-2019.
Пример раздела «Содержание» для ТУ, разработанного в
соответствии требованиями этого стандарта, приведен на рисунке 22.
|
|
|
Рисунок
22 Раздел «Содержание» технических условий устройства
«ДУГА-МТ» |
При
разработке этого раздела ТУ названия разделов и подразделов не вызывали
возражений. Теперь же, по прошествии многих лет, оказалось, что названия
подразделов требуют редакторской правки.
Сравнивая
содержимое таблиц 1 и 2 с названиями подразделов 1.1 – 1.12 (см. рисунок 22) с
написанным в п. п. 5.1.1 ГОСТ 2.114-2016 можно увидеть, что в них слишком часто
повторяется слово «требования», ведь из 12 подразделов 11 названы с
использованием этого слова.
Задача 10[1] Используя
текст технических условий, размещенный здесь,
стандарты ГОСТ З 2.102-2019 и ГОСТ 2.114-2016, предложить новые названия для
раздела 1 и его подразделов.
Что
даёт подготовка раздела «Содержание»? Прежде всего – возможность оценить
структуру документа, логичность его построения, отсутствие многословия в
названиях разделов и подразделов
Дополнительный
элемент текстового документа с названием «Содержание» целесообразно
разрабатывать всегда.
