Всё для технического документирования
+7 (495) 001-40-42
Разработка технической документации
Курсы для технических писателей
Программное обеспечение

Адвокат пользователя: никто не читает документацию (часть 2)

17.09.2014

17.09.14Марк Бейкер предлагает нам пути решения одного из главных вопросов профессии технического писателя – нужны ли кому-то результаты наших трудов. «Нужны, – утверждает автор, – но немного не в том виде, в котором мы привыкли их представлять».


Создаём для поиска информации, а не чтения

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

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

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

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

Создаём для поиска, а не для оглавления

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

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

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

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

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

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

ИсточникUsers’ Advocate: Nobody Reads Documentation

Тэги: ,

< Вернуться к списку публикаций

Облако тегов