пятница, 9 августа 2013 г.

Документация продукта: степень ее пригодности решает получатель

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

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

Большинство продуктов на рынке обладают некой документацией - первый шаг в правильном направлении - однако, пользователи продукта сталкиваются со следующими трудностями:

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

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

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

Комментариев нет:

Отправить комментарий