В ходе исследования были выделены следующие основные группы вариантов представления информации в нормативно-справочной документации [1], [2], [3]:
- Текстовая информация;
- Графическая информация;
- Табличная информация;
- Гибридная информация;
- Элементы оформления;
- Исправления и ошибки.
1. Текстовая информация
Большая часть смысловой нагрузки в технической документации приходится именно на текст — он может быть как самостоятельным, так и выполнять функцию пояснения для чертежей или таблиц [4] [5]. Данная группа делится на следующие варианты представления информации:
1. Обычный текст — служит для описания сути документа, пояснения к чертежам и таблицам, введения понятий и т. д. Пример представлен на рисунке 1
Рис. 1. Обычный текст
2. Списки — предназначены для перечисления параметров, пошагового описания вычисления и т. д. Списки могут быть как нумерованными (рис. 2), так и ненумерованными (рис. 3). Первые чаще всего используются именно для описания алгоритмов, а вторые для введения групп параметров.
Рис. 2. Нумерованный список
Рис. 3. Ненумерованный список
3. Заголовки — предназначены для смыслового разделения текста технической документации. Могут быть нескольких уровней (рис. 4).
Рис. 4. Заголовки
4. Формулы — служат для формализации описанных в технической документации процессов (рис. 5)
Рис. 5. Формулы
2. Графическая информация
Техническая документация всегда сопровождается некоторым объёмом графической информации. В большинстве случаев это чертежи, описывающие какую-либо детали или технологический процесс. К данной группе можно отнести [4] [5]:
1. Чертежи — предназначены для описания структуры или формы детали, для отображения сути технологического процесса и т. д. Чертёж может иметь разную степень детализации — от описания всех размерных параметров детали до характеризации конкретного аспекта. Также следует отметить, что данный вариант представления может включать в себя несколько проекций. Пример чертежа приведён на рисунке 6.
Рис. 6. Чертёж
2. Графические обозначения — предназначены для замены определённого понятия или определения для сокращения общего объёма технического документа. Пример представлен на рисунке 7.
Рис. 7. Графические обозначения
3. Табличная информация
Для описания возможных значений параметров в рамках описываемого технологического процесса в зависимости от различных условий в технической документации чаще всего применяются таблицы. В данном случае, основные две группы:
1. Нормализованные таблицы — чаще всего применяются для описания более простых параметров, не имеющих высокой вариативности и не зависящих от множества значений других переменных. Пример представлен на рисунке 8.
Рис. 8. Нормализованная таблица
2. Ненормализованные таблицы — зачастую предназначены для описания более комплексных параметров, зависящих от множества факторов. Пример представлен на рисунке 9.
Рис. 9. Ненормализованная таблица
4. Гибридная информация.
Зачастую автору технического документа бывает недостаточно описанных выше самостоятельных вариантов представления информации, вследствие чего он вынужден их совмещать, чтобы в полной мере перенести описываемое изделие или процесс на бумагу. К данной группе можно отнести следующие «гибриды» [5]:
- Четрежи с уточнениями и пояснениями (Рис. 10);
- Таблицы, включающие формулы или развёрнутые текстовые описания (Рис. 11);
- Таблицы, включающие графическую информацию (Рис.12).
Рис. 10. Чертёж с пояснениями
Рис. 11. Таблица, включающая формулы
Рис. 12. Таблица, включающая чертежи
5. Элементы оформления
Помимо информации, характеризующей технологический процесс или деталь, в технической документации также могут встречаться элементы, носящие служебный характер. К ним можно отнести следующие:
- Основная надпись — предоставляет информацию о номере документа, авторе, проверяющем и т. д. Может быть двух типов: полной (рис. 13), для первой страницы, и сокращённой (рис. 14), для всех остальных;
Рис. 13. Полная основная надпись
Рис. 14 Сокращённая основная надпись
- Ограничивающая рамка — служит для отделения основной содержательной части от полей листа, где может быть указана вспомогательная информация или различные пояснения;
- Внешний контур — предназначен для указания служебной информации или, в случае крайней необходимости, различных пояснений (рис. 15).
Рис. 15. Внешний контур
6. Исправления и ошибки
По причине того, что большинство технических документов до недавнего времени заполнялись от руки, при анализе велика вероятность встретить исправления и ошибки. Они могут быть как незначительного объёма (замена слова или орфографическая ошибка), так и исключающими целые страницы. К данной группе можно отнести следующие варианты исправления:
- Обычные описки и грамматические ошибки;
- Исправления, полностью исключающие объект из технического документа. Пример представлен на рисунке 16;
Рис. 16. Исключающее исправление
- Исправления, заменяющие один элемент на другой;
- Исправления, дополняющие фрагмент технического документа. Пример представлен на рисунке 17.
Рис. 17. Дополняющие исправления
Литература:
- ГОСТ 3.1001–2011 «Единая система технологической документации. Общие положения» (дата обращения 22.01.2023)
- ГОСТ 3.1102–2011 «Единая система технологической документации. Стадии разработки и виды документов. Общие положения» (дата обращения 22.01.2023)
- ГОСТ 2.001–2013 «ЕСКД. Общие положения» (дата обращения 22.01.2023)
- Единая система технологической документации. Wikipedia.org. Онлайн энциклопедия [Электронный ресурс]. URL: https://ru.wikipedia.org/wiki/Единая_система_технологической_документации (дата обращения 25.01.2023)
- Единая система конструкторской документации. Wikipedia.org. Онлайн энциклопедия [Электронный ресурс]. URL: https://ru.wikipedia.org/wiki/Единая_система_конструкторской_документации (дата обращения 25.01.2023)