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

Возможность получения доступа к огромному объёму информации привела к тому, что люди перестали читать. Да-да, мы больше не читаем. Мы “сканируем”. Бегло просматриваем страницы книг, веб-сайтов, технической документации. Физиологическая сторона вопроса понятна. Так наш мозг просто защищается от перегрузки бесконечным потоком информации.

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

Итак, три простых правила форматирования для лёгкого “сканирования”:

1. Используйте заголовки

Заголовки - одни из основных элементов, которые используются при “сканировании”. Читатель, мельком взглянув, принимает решение читать текст под заголовком или пропустить. В связи с этим, заголовки в технической документации должны быть чётко сформулированы и отражать суть той части документа, к которой они относятся.

Теперь относительно оформления. Есть два важных момента:

  • если используется более одного уровня заголовков, убедитесь, что они явно визуально различаются. Сравните:

Оформление заголовков разных уровней

  • не позволяйте заголовкам “болтаться” в пространстве, располагайте их ближе к абзацам, которые они представляют, нежели после которых следуют (примеры сгенерированы с помощью fish-text.ru).

Расположение заголовка ближе к абзацу

В варианте “А” при “сканировании” может создаться впечатление главной мысли по окончании абзаца. Вариант “Б” явно “говорит”, что это заголовок следующего за ним абзаца (раздела).

2. Сокращайте абзацы

Во-первых, техническая документация - это всё-таки не художественное произведение. Никакой “воды”, всё только по делу.

Во-вторых, всё та же причина, упомянутая в самом начале заметки, не позволяет нам, техническим писателям, злоупотреблять вниманием и временем пользователей. Длинные абзацы отпугивают читателей.

Любой длинный абзац можно разделить, как минимум, на два коротких.

3. Используйте списки

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

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

Списки в оформлении технической документации

Выполнение перечисленных выше трёх правил форматирования значительно улучшает процесс “сканирования” технической документации. Это позволяет пользователям быстро находить нужную для них информацию.