Борьба с пренебрежением к файлам справки с помощью фокусировки на контенте (часть 1)

12.08.2013

Представляем первую часть статьи Тома Джонсона, посвящённую проблемам написания файлов справки.

Долгое время я улучшал параметр лёгкости нахождения информации в документе как решение проблем документации. Но недавно я стал уже меньше уверен в том, что улучшение параметра находимости решит недостатки документации. Вместо этого стал убеждён, что настоящая проблема документации – неправильный контент сам по себе, не всегда позволяющий людям найти то, что нужно. Почему? Потому что «это» часто отсутствует. Пользователь пытается найти что-то, что не было создано.

Что на самом деле неправильно

Для начала краткое напоминание. Несмотря на то, что многие улучшения в технических коммуникациях позволили нам стать более эффективными – например, единый источник нашего контента, пропускаемый через множество каналов, подгонка контента в чётко определяемые структуры, подготовка хорошо выглядящих HTML, PDF и вывод на мобильные устройства без необходимости уметь программировать взаимодействие между форматами – многие пользователи всё ещё разочаровываются в файлах справки. Они всё ещё смотрят на них с пренебрежением.

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

Почему страдает содержимое файлов справки

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

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

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

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

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

Во второй части статьи речь пойдёт о конкретных способах улучшения качества контента в файлах справки.

Источник: Turning Around the Disdain for Help by Focusing on Content

Тэги: справка, эффективность