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.
Следующая статья
Бизнес и экономика
Конвергенция как основа для инноваций – Питер Друкер
Следующей характерной (и поистине уникальной) чертой инноваций, обоснованных на новых знаниях, является то, что они, как правило, строятся на конвергенции нескольких видов знаний и совсем необязательно относящихся к области науки и техники. Среди самых полезных для человечества нововведений текущего столетия, безусловно, следует назвать гибридаизацию в области растениеводства и животноводства. Именно гибридизация сделала возможным обеспечение пищевыми продуктами гораздо большего числа людей чем предполагалось полвека назад. Первой успешно выведенной новой...
Бизнес и экономика
Конвергенция как основа для инноваций – Питер Друкер
Бизнес и экономика
Как преодолеть сопротивление инновациям в компании
Иностранные языки и лингвистика
Как определяют уровень владения языком в разведывательных службах
Бизнес и экономика
Как социальная реклама сглаживает национально-религиозные противоречия?
Бизнес и экономика
PRотив насилия: как социальная реклама спасает детей?
Бизнес и экономика
Как TikTok набирал популярность в Китае в начале развития
Бизнес и экономика
Работай только с лучшими, даже если они твои конкуренты
Бизнес и экономика
Как анализировать задание, чтобы исключить ошибки при выполнении
Бизнес и экономика
Что нужно знать спикерам перед выступлением? Приемы ораторского мастерства
Бизнес и экономика
Разное отношение к визуальному контакту между собеседниками в арабской и европейской культурах
Педагогика и образование
Сидим правильно: за роялем и не только
Бизнес и экономика
Salesforce: как опередить конкурентов
Бизнес и экономика
Что объединяет фанатичных религиозных проповедников и руководителей национал-социалистической пропаганды?
Бизнес и экономика
Как оптимизировать производство и начать экономить?
Бизнес и экономика
Как составить план, который будет работать?
Бизнес и экономика
Как воинская повинность повергает общество в нищету