Содержание

18 июля 2023 в 17:55

   Стандарт ГОСТ Р 2.105-2019 рекомендует включать раздел «Содержание» в текстовой документ, объем которого превышает 24 листа.

        Однако с точки зрения технического писателя, составителя или разработчика технического документа, составление раздела «Содержание» перед началом работы над документом является обязательным, даже если этот раздел не будет включен в окончательную редакцию документа.

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

Такой «черновик» раздела «Содержание» выглядит совсем по-другому, чем он описан в стандарте ГОСТ Р 2.105-2019.

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

        На рисунке 21 приведен пример такого файла для раздела «Содержание» данного справочного пособия.

 О том, как оформляют раздел «Содержание» при включении его в текст документа подробно рассказано в разделе 6.2 стандарта

ГОСТ Р 2.105-2019.

        Пример раздела «Содержание» для ТУ, разработанного в соответствии требованиями этого стандарта, приведен на рисунке в начале публикации.

При разработке этого раздела ТУ названия разделов и подразделов не вызывали возражений. Теперь же, по прошествии многих лет, оказалось, что названия подразделов требуют редакторской правки.

Сравнивая содержимое таблиц 1 и 2 с названиями подразделов 1.1 – 1.12 (см. рисунок 22) с написанным в п. п. 5.1.1 ГОСТ 2.114-2016 можно увидеть, что в них слишком часто повторяется слово «требования», ведь из 12 подразделов 11 названы с использованием этого слова.

Задача 10[1] Используя текст технических условий, размещенный здесь, стандарты ГОСТ З 2.102-2019 и ГОСТ 2.114-2016, предложить новые названия для раздела 1 и его подразделов.

Что даёт подготовка раздела «Содержание»? Прежде всего – возможность оценить структуру документа, логичность его построения, отсутствие многословия в названиях разделов и подразделов

Поэтому дополнительный элемент текстового документа с названием «Содержание» целесообразно разрабатывать всегда.

[1] К этой задаче будет дан комментарий.