Содержание статьи:
- Зачем нужны списки в техническом тексте
- Как правильно обозначать элементы списка
- Пунктуационное оформление списков
- Как правильно согласовывать элементы списка
Технический писатель не может существовать и трудиться изолированно от всех остальных бизнес-процессов. Поэтому нам представляется полезным постоянно расширять взгляд на профессию, включая в наши статьи максимально актуальную информацию.
С одной стороны, для успешной работы техническому писателю необходима информация из технической области. Без этих знаний создаваемый им контент будет выглядеть поверхностно и непрофессионально. С другой стороны, нельзя забывать о собственно писательских навыках (как о стиле изложения информации, так и о простом знании грамматики и синтаксиса).
Поэтому мы решили сделать серию статей, посвященных именно языковой стороне технического писательства. В статье «Штампы информационного стиля», мы постарались собрать рекомендации о том, как избежать превращения интересной статьи в скучный официальный документ, написанный на канцелярском жаргоне.
Сегодня мы расскажем о правилах оформления списков – неотъемлемой части любого технического документа. Читайте небольшое пособие о том, как обозначить элементы списка, о тонкостях пунктуации, правилах согласования перечисляемых элементов, написания списков и др.
Зачем нужны списки в техническом тексте?
Для начала давайте вспомним, зачем нужны списки или перечни в техническом тексте. Очевидный ответ – для правильного изложения стандартных процедур, без которых невозможна техническая документация. Однако у списков есть и другие функции.
Представьте себе технический документ без списков. Это непрерывный текст, равномерно распределенный автором по странице, восприятие которого будет сильно затруднено для читателей. Другими словами, при чтении такого текста нельзя почувствовать ничего кроме усталости.
Списки значительно облегчают восприятие информации, т.к. представляют собой визуальные разделители текста. Они помогают структурировать контент и делают его более удобным для понимания. Таким образом, списки косвенно влияют на повышение UX-параметров документации.
Выражаясь простым языком, списки повышают читабельность контента. Они позволяют быстро сканировать текст, облегчая читателям поиск нужных сведений, без необходимости читать длинные абзацы.
Еще один интересный факт: списки – важный элемент, на котором фокусируется внимание при обучении различным техникам скорочтения. Известно, что списки – прямой путь для быстрого чтения и усвоения информации. Иногда достаточно просмотреть заглавия и пункты списка, чтобы получить общее представление о тексте. Таким образом, исчезает необходимость тратить время на чтение всего документа. Фактически, если в тексте нет списков, к нему неприменим основной инструмент скорочтения – сканирование. Последнее состоит в том, чтобы фокусироваться только на ключевых словах и фразах, а именно с них и начинается каждый элемент списка.
Получается, списки являются важным инструментом для эффективного представления и восприятия информации в техническом тексте.
Как правильно обозначать элементы списка?
В контексте правил оформления списков нет какой-то одной «прописной истины», которая была бы абсолютно верной для всех случаев. Существует несколько способов обозначать элементы списка.
В первую очередь, это маркированный список, в котором все элементы обозначаются с помощью маркера (bullet points – в переводе с английского «следы от пуль»). То есть элементы обозначаются круглыми точками, звездочками, тире или другими символами. Преимущества данного способа в том, что он легко воспринимается и создает визуальное отделение между элементами списка.
Например:
- Элемент 1
- Элемент 2
- Элемент 3
Следующий популярный вариант – нумерованный список, в котором элементы обозначаются цифрами или буквами (любыми маркерами, которые имеют свойство отображения последовательности или порядка перечисления). Преимущества этого подхода в возможности приоритизации элементов (элементы в начале списка более важны).
Например:
- Элемент 1
- Элемент 2
- Элемент 3
Более необычный способ – это список с чекбоксами. Здесь элементы обозначаются квадратными или круглыми чекбоксами, в которых можно ставить галочки или, наоборот, снимать их. Преимущество данного способа в том, что он позволяет отслеживать выполнение или невыполнение определенных задач.
Например:
☑ Задача 1,
☑ Задача 2,
☐ Задача 3.
Каждый из этих способов имеет свои преимущества, и выбор зависит от цели и контекста использования списка.
Списки имеют свою внутреннюю структуру. В зависимости от сложности они делятся на одноуровневые и многоуровневые. Введение уровней организации информации позволяет структурировать контент и делает его более понятным для читателя.
Одноуровневые списки (такие как три приведенных выше примера) представляют собой простой перечень элементов, расположенных один за другим без какой-либо иерархии. Они удобны для списка пунктов или задач, которые не имеют подпунктов.
Многоуровневые списки включают в себя несколько уровней «вложенности», позволяя выделить логически связанные элементы и подэлементы, т.е. провести некую классификацию.
Например, следующую информацию по закупкам продуктов можно представить в виде иерархического списка:
- Овощи
1.1. Помидоры
1.1.1. Красные
1.1.2. Желтые
1.2. Огурцы
1.2.1. Длинные
1.2.2. Корнишоны и т.д.
Иерархические многоуровневые списки подходят для структурирования сложной информации, разбиения её на части и подчасти, с названиями, иллюстрации иерархии понятий и т.д.
Выбор между одноуровневыми и многоуровневыми списками зависит от типа информации, которую необходимо представить, и её структуры. Если список является простым перечнем независимых элементов, то одноуровневый список будет наиболее уместным. Однако, если информация требует организации по уровням иерархии, то предпочтительнее оформлять многоуровневый список.
Пунктуационное оформление списков
Правила пунктуации при оформлении списков – это сложная тема, над которой ломают копья редакторы по всему миру. Главная рекомендация здесь – это последовательность и единообразие при оформлении документации. Следует выбрать один-два формата и строго придерживаться этих правил. Так вы сможете создать впечатление единства текста и облегчить восприятие информации для читателей.
Сразу оговоримся, что упрощенное представление списков вполне возможно. При таком составлении в конце каждого элемента отсутствуют знаки препинания (запятые или точки с запятыми). Такие списки часто используются на веб-страницах для удобства чтения и визуального оформления.
Например:
- Яблоки
- Апельсины
- Груши
В данном случае мы видим, что после элементов списка отсутствуют запятые или другие знаки препинания.
Однако в формальных текстах необходимо использовать знаки препинания. Здесь будут действовать следующие правила пунктуации:
Простые нумерованные и ненумерованные списки:
- Каждый элемент списка должен начинаться с заглавной буквы.
- Если элемент списка краткий и односложный, то после него можно не ставить точку (если весь список краткий и односложный).
- Если элемент списка состоит из нескольких предложений, содержит описание, то после каждого элемента необходимо ставить точку с запятой.
Пример ненумерованного списка:
- Яблоки,
- Апельсины,
- Груши (сравните с примером выше).
Сложные списки:
- Если элемент списка содержит запятую, двоеточие или другие знаки препинания внутри себя, то после него ставится запятая.
- После последнего элемента списка ставится точка (если весь список не является частью предложения).
Пример сложного списка:
- Помидоры, огурцы, лук и зелень,
- Молоко, яйца, сахар и мука,
- Помыть посуду, приготовить ужин, прибраться в комнате.
Эти правила позволяют сделать список более удобочитаемым и легко воспринимаемым. Правильное пунктуационное оформление способствует ясности и структурированности текста. В целом, использование знаков препинания в списках зависит от контекста и стиля письма, и иногда можно обойтись без них, особенно в случае кратких и простых списков.
Как правильно согласовывать элементы списка?
Элементы списка необходимо согласовывать по части речи и значению. Например, если список содержит существительные, то все существительные должны быть однородными (согласовываться в падеже). Если список содержит прилагательные, то они должны быть в единственном или множественном числе в соответствии с существительным, к которому они относятся.
Например, правильное согласование элементов списка в предложении:
В офисе не было:
- стульев,
- холодильника,
- компьютеров,
- шкафа-купе.
Также важно согласовывать элементы списка по значению, чтобы они были логически связаны друг с другом и образовывали единое целое.
Чтобы получить более подробную информацию о требованиях к спискам в конкретных случаях можно обратится к требовниям ГОСТ, связанным с оформлением документов.
***
Оформление технической документации без списков и перечней может стать причиной негативного впечатления о контенте у ваших пользователей. Главным недостатком большинство из них назовет неупорядоченность информации. Действительно, без использования списков и перечней ваши документы будут выглядеть беспорядочно.
Еще одна проблема. На которую обязательно обратят внимание пользователи, – это затруднение навигации. Без четкого разделения информации на списки и перечни пользователь может испытывать затруднения при поиске конкретных данных или справочной информации.
Использование списков, перечней и структурирование информации в технической документации помогает повысить ее четкость, доступность и удобство использования.
