Стандарт ГОСТ Р 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] К этой задаче будет дан комментарий.
Никто пока не комментировал эту страницу.
Стандартом установлено, что ссылаться можно на сторонний документ в целом, его разделы и приложения, а ссылаться на подразделы, пункты, таблицы и рисунки стороннего документа не допускается (см. Сноска).
В тексте документа можно ссылаться на подразделы, пункты, таблицы и рисунка данного документа.
Специальные правила установлены стандартом [2] и для ссылочных нормативных документов.
Структурный элемент библиография предписано размещать в конце текстового документа, перед листом регистрации изменений, и включать его в раздел содержание.
Про два других вида ссылок никаких рекомендаций в [2] не содержится, поэтому целесообразно установить единые правила расположение ссылочных нормативных документов и ссылочных документов в приложениях к текстовому документу, не ограничиваясь фразой «Материал, дополняющий текст документа, допускается оформлять в виде приложений»
См. Ссылки и сноски
Литература
1 ГОСТ Р 2.005-2023. ЕСКД. Термины и определения
2 ГОСТ Р 2.105-2019. ЕСКД. Общие требования к текстовым документам
3 ГОСТ 7.32 -2017. Отчет о научно-исследовательской работе
4 Ссылки и сноски // [Электронный ресурс], режим доступа:
https://energoboard.ru/post/7758/ (485 просмотров с 01 .08.2023 по 07.07.2026 или 485/1072 = 0,45 просмотра в день)
5 Ссылочные документы // [Электронный ресурс], режим доступа:
https://energoboard.ru/post/7741/ (1831 просмотр с 26.07.2023 по 07.07.2026 или 1831/1040 = 1, 76 просмотра в день)
8 ГОСТ Р 2. 2005-2023, ЕСКД. Термины и опредления
Кроме этого, правила учета и хранения документов должны быть едиными для конструкторских, программных, технологических и других документов, поэтому следует выпустить вместо двух стандартов
ГОСТ 19.603-78 и ГОСТ.503-78 единый стандарт, распространяющийся на все существующие системы документов.
Перечень литературы дополнен стандартом ГОСТ 19.603-78:
Литература
1 ГОСТ Р 2.105-2019. ЕСКД. Общие требования к текстовым документам.
2 ГОСТ 2.503-2013. ЕСКД. Правила внесения изменений.
3 ГОСТ 3.1103-2011. ЕСТД. Основные надписи
4 ГОСТ 2.004-88. ЕСКД. Общие требования к выполнению конструкторских и технологических документов на печатающих и графических устройствах вывода ЭВМ.
5. ГОСТ 2.501-201. ЕСКД. Правила учета и хранения.
6 ГОСТ 19.603-78. ЕСПД. Общие правила внесения изменений
6 Лист регистрации изменений // [Электронный ресурс], режим доступа: https://www.olgezaharov.narod.ru/2023/august/LR.htm
7 Лист регистрации изменений // [Электронный ресурс], режим доступа: https://energoboard.ru/post/7779/ (673 просмотра с 07.08.2023 по 08.07.2026 - 673/1066 = 0, 63 просмотра в день)