Разработчики документации регулярно сталкиваются с такими вопросами:

  • Какой тип списка выбрать?
  • Сколько уровней вложенности может быть у списков в документации?
  • Как маркировать или нумеровать уровни многоуровневых списков?

1. Ключевые моменты

В качестве основных целей составления технического документа можно выделить:

Список – это не совсем верный термин. Правильный термин: перечисление.

Перечисление – это структурный элемент документа. Кроме перечислений структурными элементами документа являются:

  • раздел (заголовок первого уровня);
  • подраздел (заголовок второго уровня),
  • пункт (заголовок третьего уровня);
  • подпункт (заголовок четвертого уровня).

Чаще всего перечисления используются в пунктах и подпунктах. При этом разные стандарты имеют разные требования относительно допустимости применения перечислений на уровне раздела и подраздела.

На практике перечисления часто встречаются на уровне подраздела и даже на уровне раздела (если раздел не содержит подразделов). Это можно считать допустимым при отсутствии явных замечаний со стороны заказчика/потребителя документа.

 

Когда документация выпускается по каким-то конкретным стандартам или сериям стандартов (ЕСКД, ЕСПД, КСАС и пр.), то оформление перечислений не должно противоречить требованиям соответствующего стандарта.

Требования к оформлению перечислений для документов, выпускаемых в соответствии с ЕСКД и КСАС, приведены в ГОСТ Р 2.105-2019 (подраздел 6.7).

Требования к оформлению перечислений для документов, выпускаемых в соответствии с ЕСПД, приведены в документе ГОСТ 19.106-78.

2. Что такое «Маркированный» и «Нумерованный»?

Под термином «маркированный список» обычно понимается такое перечисление, в котором для обозначения каждой позиции перечисления используется дефис или иной символ, единый для всех элементов перечисления одного уровня.

Пример одноуровневого маркированного списка:

  • трамвай;
  • автомобиль;
  • автобус.

Пример двухуровневого маркированного списка:

  • трамвай;
  • автомобиль:

— кузов;

— двигатель;

— бензобак;

  • автобус.

  • Под термином «нумерованный список» обычно понимается такое перечисление, в котором для каждого элемента перечисления используются разные буквы или цифры (в возрастающей последовательности).

    Пример двухуровневого нумерованного списка из ГОСТ Р 2.105–2019:

3. Какой список выбрать?

Рекомендуется придерживаться 3-х правил:

  • Правило 1. Не использовать нумерованные списки во всех случаях, когда можно обойтись без них. Это уменьшит вероятность «поломок» нумерации при многократном редактировании документа в процессе его жизненного цикла.
  • Правило 2. Обязательно использовать нумерованные списки, когда в документе или смежных документах имеются (т.е. требуются) ссылки на отдельные элементы перечисления (рекомендуется заранее учитывать смежные и/или «будущие» документы).

    Например:

    В техническом задании (ТЗ) полезно использовать нумерацию в некоторых перечислениях, т.к. ссылки на отдельные элементы перечислений вполне могут потребоваться в будущем документе типа «Программа и методика испытаний» (ПМИ).

  • Правило 3. Допустимо (на усмотрение автора) использовать нумерованные списки, если:

    — после нумерованного списка следуют пункты / подпункты с расшифровкой (детализацией) тезисов из списка. При этом такие пункты / подпункты выделены и имеют нумерацию;

    — список предполагает описание некоторой последовательности шагов, которую нужно выполнять последовательно (т.е. по смыслу это «делай раз», «делай два», «делай три»).

4. Сколько уровней вложенности допустимо?

  • В перечислениях следует придерживаться правила:

    «Не более 2-х уровней вложенности». Если перечисление требует 3-х или более уровней вложенности – это серьезный повод задуматься о корректности структуры документа. Особенно в части деления на разделы, подразделы, пункты и подпункты.

    Важно учитывать:

    Число уровней вложенности заголовков в документе считается «нормальным», когда присутствует до 4-х уровней: (раздел, подраздел, пункт, подпункт).

    Наличие 5 уровней вложенности в документе – это допустимо, но уже является серьезным поводом задуматься о структуре документа.

    Более 5 уровней вложенности заголовков – плохое решение. В этом случае следует задуматься о делении документа по частям (томам) или о делении контента по разным документам.

Получить консультацию по документам

Оставьте заявку на обратный звонок или свяжитесь с нами:

Позвонить
Написать
Telegram

Нажимая кнопку «Отправить», вы соглашаетесь с нашей Политикой конфиденциальности