Таблицы в технической документации
На днях проверял домашнюю работу сына по биологии. Перед ним стояла задача составить конспект по заданной теме. К слову, мальчик учится в пятом классе. Ранее мы с ним разбирали несколько способов составления конспекта. Одним из наиболее эффективных из них оказался следующий: выделение маркером нужного материала на копиях (распечатанных) страниц учебника с последующим переформулированием текста и запись полученного в тетрадь (это так, поделился с коллегами-родителями).
Итак, анализируя очередной конспект сына, выяснил, что основная мысль материала - сравнение двух групп некоторых объектов. Профессиональная привычка сразу же заставила перевести отображение сплошного текста в более понятное представление, которое позволит быстро прочитать и вспомнить материал по заданной теме.
Таким представлением конечно же является таблица. Конспект был переписан в виде таблицы. При этом сам ребёнок в итоге понял, что такой вариант записи гораздо понятнее, чем предыдущий (в данном конкретном случае).
К чему я это рассказал? В технической документации всё то же самое. Очень часто используются большие объёмы сплошного текста, где лучше бы и проще оформить материал в виде простой таблицы.
Вот о таблицах и пойдёт речь в заметке.
Таблица - это элемент визуализации текстово-цифровой информации в структурированном и наглядном виде, состоящий из следующих основных компонентов:
- номер,
- наименование,
- заголовок (шапка),
- тело.
Нумерация таблицы
Все таблицы документа должны последовательно нумероваться арабскими цифрами (например, “Таблица 1”).
Существуют два варианта нумерации таблиц:
-
сквозной (таблицы нумеруются последовательно по всему документу, независимо от того, в каком разделе они находятся. Например, “Таблица 1”, “Таблица N”);
-
секционный (в каждом разделе документа таблицы нумеруются последовательно и независимо от таблиц других разделов. В этом случае нумерация содержит номер раздела и порядковый номер самой таблицы. Например, “Таблица 1.1” - таблица №1 в разделе №1, “Таблица 1.N” - таблица №1 в разделе №N, “Таблица N.N” - таблица №N в разделе №N”).
Здесь надо добавить оговорку. Например, к таблицам приложений всегда применяется секционный вариант нумерации. Отличие лишь в том, что вместо номера раздела (приложения) может использоваться заглавная буква. Например, для Приложения 1 - “Таблица 1.1”, для Приложения А - “Таблица А.1”.
Номер указывается сверху непосредственно над таблицей. Что касается выравнивания (по левому или правому краю), то здесь тоже нужно руководствоваться требованиями к оформлению документа в каждом конкретном случае. Например, согласно общим требованиям к текстовым документам ЕСКД (ГОСТ Р 2.105-2019) слово “Таблица” с порядковым номером указываются слева.
Наименование таблицы
У каждой таблицы должно быть точное и краткое наименование, отражающее её суть. При этом наименование следует сразу за порядковым номером (например, “Таблица 1. Правила форматирования документации”).
Кстати, в соответствии с упомянутыми выше требованиями ЕСКД, номер таблицы и её наименование должны быть разделены знаком “тире” (например, “Таблица 1 - Правила форматирования документации”), но многие руководства по оформлению в качестве разделителя допускают “точку”.
Наименование также указывается над таблицей. Правила выравнивания применяются аналогично оформлению номера таблицы.
Заголовок таблицы
Под заголовком (шапкой) таблицы понимаются первые строки, содержащие в себе описания столбцов. Другими словами, заголовок необходим для понимания того, какие данные содержатся в таблице. В зависимости от типа таблицы заголовок может размещаться горизонтально, вертикально или же в двух вариантах одновременно.
Наименования столбцов должны начинаться с заглавной буквы и без знаков препинания в конце.
Тело таблицы
Тело таблицы является её основной частью и состоит из строк и столбцов. Пересечение строки и столбца называется ячейкой. Здесь содержится структурированная информация, которую требуется донести до читателя.
Текстово-цифровая информация таблицы оформляется таким же шрифтом, что и основной текст документа. Размер шрифта может быть на 1 - 2 кегля меньше, чем размер основного текста документа. Но всё же не рекомендуется использовать размер меньше десятого. Слишком уж мелко получается и напоминает какой-то кредитный договор с бесконечными сносками, написанными микроскопическим шрифтом.
Размещение таблицы
Таблицу в технической документации необходимо размещать рядом с тем местом, где она впервые упоминается в тексте (очень желательно сразу после абзаца, в котором таблица упоминается). При этом обращение к таблицам в тексте документа должно выполняться по их номерам, а не по их расположению в тексте.
Сравните два представленных варианта:
Вариант “Б” однозначно и явно указывает на конкретный объект документа, чего не скажешь о варианте “А”.
Если при написании документации применяются текстовые “вордоподобные” редакторы, то необходимо пользоваться всеми имеющимися у них возможностями. Вот и в данном случае для обращения к таблице лучше всего применять перекрёстные ссылки. Это позволит избежать путанницы в номерах таблиц, а также позволит автоматически обновлять их номера при добавлении новых объектов.
Подведу небольшой итог. Таблицы - это верные помощники технического писателя, которые позволяют компактно и понятно донести нужную информацию до читателя.
Несколько основных правил использования таблиц:
- таблица должна быть размещена максимально близко к тому месту, где впервые упоминается;
- таблицы документа должны быть пронумерованы и иметь наименования;
- текст таблицы форматируется тем же шрифтом, что и основной текст документа;
- размер шрифта содержимого таблицы может быть меньше шрифта основного текста на 1 - 2 кегля, но всё-таки лучше не меньше десятого;
- если таблица размещается на двух и более страницах, то заголовок должен отображаться на каждой странице.