Стандарт ГОСТ Р 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] К этой задаче будет дан комментарий.
Никто пока не комментировал эту страницу.
В стандарте [6] предусмотрено присваивать различным документам вида «расчет» код[1] документа РР, а для локальной сметы код документа ЛС.
Никакой необходимости использовать код Б для обозначения документов, в названии которых нет слова «Обоснование», не существует, а отсутствие документов, в названии которых использовано это слово подтверждает, что из ГОСТ 34.201-2020 должен быть исключен фактически не существующий документ «Обоснование».
Литература:
6 ГОСТ Р 21.101-2020 Основные требования к проектной документации
7 Н. Зенин. Судьба требований ГОСТ 34-й серии в проектах по информационной безопасности // [Электронный ресурс], режим доступа: https://www.anti-malware.ru/practice/methods/GOST-requirements-34th-series-in-information-security-projects
[1] В данном стандарте вместо термина «код документа» используют словосочетание «шифр документа»
Разработчики стандартов иногда предлагают новые виды документов, объясняя это тем, что существующих видов документов недостаточно для новых изделий. Например, в таблице 1 стандарта [1] перечислены несколько видов документов, разрабатываемых для автоматизированных систем (далее АС). Обратим внимание на документ «Обоснование» (код документа Б). Его назначение определено так:
«Изложение сведений, подтверждающих целесообразность принимаемых решений»
Отметим, что в числе толкований значений слова «обоснование» есть и тексты, служащие основанием для принятия решения.
Какие же текстовые документы приведены в таблице 2 стандарта [1], где перечислены конкретные документы?
Как ни странно, но документа со словом «обоснование» в названии нет ни в стандарте [1] нет, как нет его и в отменном руководящем документе [2].
Слово «обоснование» в [2] использовано в названии раздела отчета, разрабатываемого на стадии формирования требований к АС – Обоснование необходимости совершенствования информационной системы объекта.
«Обоснование» содержится ещё в двух стандартах [3, 4], где применено в названии этапа работы – Обследование объекта и обоснование необходимости создания АС.
Отметим, что в cтандартах [3, 4] обоснование необходимо для вынесения технико-экономической, социальной и т.п. оценок на стадии формирования требований к АС.
При этом сам документ, содержащий результаты обоснования, оформляют в виде отчета по ГОСТ 7.32 [5], а не в виде документа вида «Обоснование».
Обратимся теперь к стандарту [1] и посмотрим какие же документы с кодом Б (присвоен документу «Обоснование») указаны в таблице 2:
- локальный сметный расчет (код Б2);
- проектная оценка надежности системы (код Б1);
- локальная смета (код Б3).
Из перечисления видно, что ни в одном из названий этих документов с кодом Б нет слова «Обоснование».
Продолжение следует