В предыдущей заметке шла речь о таблицах. В текущей же заметке решил продолжить тему оформления текста документации. Итак, применение списков в технической документации.

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

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

Длина списка

Длина списка - это число элементов этого списка.

Каждый список должен содержать минимум два элемента, иначе это уже не список.

Что же касается максимального значения элементов, то здесь однозначного ответа нет. По крайней мере в русскоязычной литературе мне подобная информация не встречалась. При этом многие англоязычные ресурсы по этому поводу ориентируются на исследования NASA. К сожалению, первоисточник мне найти не удалось. Поэтому пока принимаю данную информацию на веру. Так вот, NASA рекомендует указывать не более восьми шагов в своих инструкциях по чрезвычайным ситуациям. Это связано с тем, что большее количество указаний перегружает мозг в кризисной ситуации. Исходя из этого, считается, что количество элементов списка не должно превышать восьми.

Так это или нет, нужно проверять на практике в каждом конкретном случае.

Типы списков

При всех плюсах списков неправильное их оформление может оказать противоположное (негативное) влияние на вопсприятие текста.

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

Наиболее распространённые типы списков:

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

Свободное пространство

Для того, чтобы повысить удобочитаемость, лучше добавить немного свободного пространства между элементами списков.

Сравните два представленных варианта:

Варианты оформления списков, свободное пространство

Несмотря на то, что оба варианта оформления структурированы, согласитесь, что вариант “Б” читается гораздо легче.

Правила пунктуации в списках

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

Не лишним здесь будет справочник по орфографии и пунктуации русского языка (я обычно пользуюсь вот этим - Правила русской орфографии и пунктуации. Полный академический справочник / Под ред. В.В. Лопатина. — М: АСТ, 2009. - 432 с. ISBN 978-5-462-00930-3).

Приведу наиболее часто встречающиеся правила пунктуации в оформлении списков технической документации:

  1. запятая ставится в конце элементов списка, если эти элементы:

    • достаточно просты (например, состоят всего из нескольких слов) и не имеют знаков препинания внутри себя;

    • обозначены цифрой с закрывающей скобкой (например, 1) первый элемент списка, 2) второй элемент списка.);

    • обозначены строчной буквой с закрывающей скобкой или без неё (например, а) первый элемент списка, б) второй элемент списка.);

    • обозначены маркером (например, точка, звёздока, тире и т.д.);

  2. точка с запятой ставится в конце элементов списка, если эти элементы:

    • сложно сформулированы и имеют знаки препинания внутри себя (например, этот список, с перечнем правил);

    • а также в случаях применения запятой с обозначением цифрами и строчными буквами с закрывающей скобкой и без неё;

  3. точка ставится в конце элементов списка, если эти элементы:

    • обозначены цифрой с точкой (например, 1) Первый элемент списка. 2) Второй элемент списка.);

    • обозначены прописной буквой с точкой (например, А. Первый элемент списка. Б. Второй элемент списка.)

Важно помнить простую мысль - всё, что можно оформить в виде списка, должно быть оформлено в виде списка.

Если в тексте встречаются перечисления через запятую или точку с запятой, то это прекрасные кандидаты для списков.

Несколько правил применения списков:

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