А вы допускаете эти ошибки? (часть 3)

20.12.2013

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

Отсутствие шаблонов

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

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

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

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

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

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

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

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

Использование шаблонов «один-подойдёт-для-всех-документов»

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

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

(продолжение следует)

Источник: Are you making this writing mistakes?

Тэги: советы, шаблоны