Часто совершаемые ошибки при оформлении документации на программный продукт

Извекова Крестина, компания DIRECTUM

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

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

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

Типы часто совершаемых ошибок

Коридоры в тексте

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

Появление таких пятен обусловлено слишком большими пробелами между словами.

Замкнутые пустоты

Замкнутые пустоты - промежутки между элементами текста, смотрятся как дыры в общей композиции.

Следует избегать появления «дыр» на странице, они нарушают естественную последовательность восприятия информации, мешают пользователю и разрушают гармонию текста и графики.

Шепчущие заголовки

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

Если контраст между заголовками и текстом недостаточен, страница кажется серой, а такие заголовки будут называться «шепчущими». Они не в состоянии привлечь внимание читателя к последующему за ним тексту.

Душные рамки

Между текстом и рамками должно быть достаточно свободного места.

Слишком плотное размещение текста в рамке или слишком близкое окружение рамки основным текстом порождают неприятное ощущение тесноты.

Прыгающий горизонт

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

Неровность верхнего края страниц затрудняет восприятие текста и разрушает целостность документации.

Заголовки на дне

Заголовки не должны находиться слишком близко к нижнему краю страницы. Такие заголовки нужно перенести на следующую страницу.

Заголовки в свободном полете

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

Выразительность и действенность заголовков снижаются, если пользователь не может сразу же определить, к какому тексту они относятся.

Лишние рамки и линейки

Не следует злоупотреблять в оформление рамками и линейками.

Из-за слишком большого количества рамок и линеек страница кажется разбитой на ряд отсеков.

Текстовые блоки неправильной формы

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

Легче всего читать текст, выровненный по левому краю. Если строки не имеют постоянной границы слева, то на чтение уходит больше времени, поскольку всякий раз приходится заново искать глазами начало.

Похожие гарнитуры

Шрифтовые гарнитуры, используемые в одной документации, должны заметно отличаться друг от друга.

Если заголовок и основной текст предполагается набирать разными шрифтами, следует подыскать контрастную пару гарнитур.

Злоупотребление поворотом текста

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

Подчеркивание

Подчеркивание ухудшает читаемость текста.

Избыток подчеркивания создает ощущение беспорядка и путаницы.

Висячие строки

Висячими называют начальные строки абзаца, расположенные в конце страницы, или концевые строки абзаца в начале страницы.

Следует контролировать появление висячих строк, так как они создают некрасивые разрывы страниц.

Неодинаковые отбивки

Отклонения от установленной величины отбивок придают документации небрежный вид, и содержащиеся в ней сведения воспринимаются как малозначительные.

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

Слишком большой абзацный отступ

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

Переизбыток шрифтов

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

Следует использовать для оформления текста только тщательно подобранные гарнитуры.

Неровно стоящие элементы

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

Нагромождение картинок

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

Теснота на странице

Документация, в которой нет свободного места и в каждый уголок втиснута какая-нибудь информация, очень трудно читается.

Серые страницы

Не следует допускать, чтобы на странице был один сплошной текст.

Если на странице не уместно вставить картинку, список, таблицу, примечание и т.д., то следует разбить текст на небольшие абзацы.

Злоупотребление справочной информацией

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

Частота появления ошибок оформления в документациях на СЭД

Для анализа частоты появления ошибок оформления мы выбрали документации четырех лидеров среди отечественных ECM-систем.

В результате анализа самыми популярными ошибками стали «Шепчущие заголовки» и «Похожие гарнитуры», они встречаются во всех без исключения документациях. Также всем вендорам, удалось избежать следующих ошибок оформления: «Коридоры в тексте», «Лишние рамки и линейки», «Злоупотребление поворотом текста», «Слишком большой абзацный отступ».

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

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

Источники:

●  Г.А. Кнабе. Энциклопедия дизайнера печатной продукции.

●  Роджер Паркер. Как сделать красиво на бумаге.