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

Советы и хитрости: Переходим от очевидного контента к ценному

13.06.2013

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


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

Что пользователи считают самым ценным в техническом контенте? Простыми словами, пользователи хотят узнать то, что им нужно знать, не больше и не меньше. У пользователей есть вопросы, и они хотят ввести их в поисковую строку и получить ссылку на статью, само название которой уже является ответом на вопрос. А еще лучше, когда после открытия ссылки пользователь убеждается, что читает именно то, что ему нужно, что статья полностью отвечает на его вопрос. Как часто такое происходит? Не так уж и часто.

Недавно я просматривала документацию по продукту, которым не знала, как пользоваться (хотя понимала основы), и обнаружила, что большая часть контента не содержит ответов на мои вопросы о том, почему необходимы некоторые действия. По мере прочтения я озадачивалась вопросами: «Зачем мне это знать?», «Что на самом деле означает этот термин, и как это понятие влияет на использование продукта?», «Почему в этом примере используется четверка? Должен ли я тоже использовать это значение? Как узнать, какое значение мне нужно использовать?». «Полученные в примере результаты правильны? Почему? Если нет, то почему?».

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

1. Проводите «Анализ корневых целей» перед созданием технического контента.

В начале проекта необходимо провести разговор между разработчиком контента и экспертом по предмету (ЭП) о том, какие задачи пользователь будет выполнять с помощью программного обеспечения. Разработчик контента может задать вопрос, и, выслушивая ответ, спросить: «Зачем пользователь должен это делать?» Многие ЭП не могут сразу же дать четкий ответ о том, чего пытаются добиться пользователи. Спрашивать «Зачем?», пока ответ не прояснит весь смысл – это и есть анализ корневых целей; он схож с анализом первопричин. Раскрытие корневых целей гарантирует, что и название темы и сама тема будут отвечать на вопросы реальных пользователей. Если вопрос «Зачем?» не работает, попробуйте спросить: «Что пользователи не смогут сделать, если этой функции не будет?» Иногда вопрос в отрицательной форме провоцирует правильный ответ.

2. Протестируйте программное обеспечение с особой внимательностью.

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

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

3. Задавайте ЭП столько вопросов, сколько необходимо, чтобы отличить очевидное от ценного.

Дар задавать вопросы – торговая марка устоявшегося разработчика контента. «Что это?», «Зачем пользователям это делать?», «Что произойдет, если я это сделаю?», «Почему пользователи не захотят это делать (вы же сами упростили им доступ к этой функции)?», «Что пользователь получит?», «Принесет ли результат пользу? Почему? Если нет, то почему?», «Что произойдет, если пользователь установит программу неправильно?», «Что может пойти не так?». Для оценки потенциальных подводных камней, с которыми может столкнуться пользователь, разработчики контента должны обращать внимание на сообщения об ошибках. Разработчик контента должен добраться до «скелета»  вопроса, рассматривая его со всех сторон, взвешивая каждый ответ ЭП. Что очевидно, а что ценно?

4. Приоритетность технического контента, ориентированного на принятие решений, решение задач и устранение неисправностей.

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

Общие темы должны описывать задачи и решения программного обеспечения. В противном случае такие темы бесполезны. Учебники часто включают в себя общие темы, но кто любит учебники? Если мы с вами похожи, вы наверняка считаете многие учебники неясными и непрактичными. Учебники являются полной противоположностью полезной технической документации. Я часто использую «тест на удаление» (delete-key test), чтобы определить содержание полезного: «Если бы мне пришлось удалить это прямо сейчас, кто-нибудь бы обнаружил пропажу? Почему да или почему нет?» Если я знаю, для чего кому-нибудь понадобилась бы информация, которую я наметила удалить, я могу ее переписать так,  чтобы контент стал более ценным.

5. Тестирование технического контента на коллегах (peertest).

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

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

Источник: Tips and Tricks: Getting from Obvious to Valuable Technical Content

Тэги: , ,

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

Облако тегов