50 вопросов для работы над пользовательской документацией

0
Акашева Василиса Игоревна10/23/2020

50 вопросов для работы над документацией:

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

Цели

1. Для кого я пишу статью? Кто будущий читатель: пользователь, администратор, разработчик?
2. Какие задачи стоят перед ним (jobs to be done)? Есть ли описание персоны?
3. Какой уровень подготовки этого пользователя? Что он уже знает? Что для него неочевидно?
4. Как можно объяснить это начинающему пользователю и при этом не злить продвинутого объяснением элементарных вещей?
5. Что ещё нужно объяснить пользователю, чтобы он понял основное содержание статьи?
6. В какой раздел документации подойдёт эта статья?
7. Эту статью или её часть надо продублировать в других разделах?
8. На какие статьи нужно ссылаться?
9. Может быть, эту статью следует сопроводить видеоинструкцией?

Источники информации

10. У текущих пользователей есть проблемы, связанные с темой статьи? 
11. Как сейчас поддержка объясняет, что надо сделать?
12. Отдел маркетинга писал на эту тему статьи и новости в блог? Можно ли у них «подсмотреть» формулировки, структуру и др.?
13. Есть ли посвящённые этой теме разделы на сайте?
14. Что в сценарий закладывал UX и продакт-менеджер? Почему сделал это так?
15. Как этот вопрос описан у конкурентов?
16. В каких сферах ещё можно посмотреть лучшие практики?

Проверка содержания

17. Удалось ли достигнуть цели статьи?
18. Всё ли будет понятно более продвинутому пользователю?
19. Всё ли будет понятно начинающему пользователю?
20. Всё логично и последовательно? Нет «скачков» и пропастей?
21. Последовательность действий верна? Сможет ли пользователь достичь цели, следуя только этой инструкции?
22. Мы учли все кейсы/пути пользователя?
23. Статья вписывается в выбранный раздел?

Проверка вёрстки

24. Есть ли нечитабельные простыни текста? Можно ли заменить схемой?
25. Есть ли длинные абзацы?
26. Есть ли слишком короткие абзацы?
27. Есть ли слишком длинные списки?
28. Есть ли слишком вложенные сложные для восприятия списки (те, в которых больше двух-трёх уровней)?
29. Изображений достаточно?
30. Изображений не слишком много? Не иллюстрируем ли мы слишком очевидные шаги?
31. Если есть схемы, они понятны?
32. Таблицы не сложны для восприятия?
33. Страница в целом смотрится хорошо?

Литературное редактирование

34. Всё оформлено по гайду?
35. Соответствует ли стиль остальной документации?
36. Есть предложения, которые можно упростить?
37. Есть сложные термины, которые требуют пояснений?
38. Есть канцеляризмы?
39. Есть повторы? 
40. Ничего не режет слух?

Финальная вычитка

41. Нет ли опечаток, ошибок в правописании и пунктуации?
42. С переносами, абзацами и разделами всё в порядке?
43. Все изображения подписаны?
44. Элементы интерфейса названы правильно?
45. Везде ли стоят ссылки? Они работают и ведут куда надо?

Сразу после публикации

46. В статье есть разделы, которые «подтягиваются» в другие статьи? Они оформлены макросами, чтобы изменения в одной статье автоматически применялись к другим?
47. На эту статью надо сослаться из других разделов? Если да, то из каких?
48. Надо добавить в продукт быструю ссылку на эту статью?
49. Надо ли отправить ссылку поддержке, маркетингу или другим отделам?
50. Надо ли отдать статью на перевод?

Этот список можно распечатать и положить на рабочий стол или повесить на стену. Или превратить в чек-лист. Часть вопросов можно вынести в бизнес-процесс. Наш, например, зафиксирован в общем процессе разработки в YouTrack. Задача по документации проходит по разным этапам и отделам, без написанной документации нельзя отдавать фичу в релиз.

И. Варнина. 50 вопросов для работы над документацией. [Электронный ресурс] HABR. — Режим доступа: habr.com/ru/company/ispsystem/blog/431456. — Дата обращения: 23.10.20.
Следующая статья
Бизнес и экономика
Фрэнсис Форд Коппола о секретах организации прямого эфира
Приходит время, когда ваш хорошо подготовленный и полный энергии актерский состав начинает, спотыкаясь, отыгрывать по целому акту за раз, потом по нескольку актов и, наконец, — постарайтесь добраться до этого момента как можно скорее — всю постановку полностью. Весь этот процесс очень похож на то, как готовится спектакль в театре, и поэтому я решил поручить его организацию театральному помощнику режиссера. Именно его голос предупреждает о том, сколько минут осталось до выхода в эфир, отсчитывает в обратном порядке время и дает указания касательно света, именно этот человек сигнализирует актера...
Бизнес и экономика
Фрэнсис Форд Коппола о секретах организации прямого эфира
Иностранные языки и лингвистика
Перевод как промышленное изделие
Бизнес и экономика
Reskilling China. Реферат по исследованию McKinsey. Часть 1
Бизнес и экономика
Неоднозначные требования в техническом задании и как от них избавиться
Бизнес и экономика
Как удержать клиента с помощью музыки?
Бизнес и экономика
«По правде сказать, я не люблю балет. Но я не дурак», или как войти в доверие к клиенту?
Бизнес и экономика
Хронометраж + видеокамера: как сократить внутренние издержки на производстве?
Бизнес и экономика
Почему опасно «‎терпеть» ухудшающееся финансовое положение in a wartime situation?
Бизнес и экономика
1 500 туземцев, ни слова по-английски и оптимизация африканского производства
Бизнес и экономика
Малый, средний и крупный бизнес. Почему так важно правильно масштабировать фирму?
Бизнес и экономика
«Недопустима даже тень сомнения в собственной правоте», или как должна работать пропаганда
Бизнес и экономика
Раскрутка сети магазинов на примере «Избёнки» и «ВкусВилла»
Бизнес и экономика
Этот самолет слишком сложен, чтобы на нем мог летать один человек
Бизнес и экономика
Питер Друкер: «Кто наш клиент?»
Бизнес и экономика
Основные положения доктрины человеческих отношений
Бизнес и экономика
НЕИЗБЕЖНОСТЬ PUBLIC RELATIONS. Часть 1. Фрагмент из книги «Приёмы рекламы и Public Relations»