Практиковаться Тренироваться
Научиться использовать продукт в обычной повседневной работе.
Пользователям необходимо научиться работать с большинством частей продукта, которые входят в круг их задач. Например, администраторы должны уметь создавать и удалять пользователей. Действие «Практиковаться» описывает потребность в процедурных знаниях — то есть в понимании того, как использовать продукт в обычной повседневной работе.
Примеры документации для практики: создание нового SSH-ключа в GitHub, импорт контактов в Mailchimp и управление пользователями в Dynatrace. В них используются разные шаблоны практических руководств и учебных материалов, с аудиовизуальными материалами или без них, но цель у них одна: помочь пользователям освоить процедуру.
Когда пользователи уверенно выполняют задачи, они охотнее исследуют расширенные возможности и становятся сторонниками продукта. Такая документация часто служит основой программ обучения пользователей и сертификационных траекторий, превращая теоретические знания в практические навыки.
Что пользователь хочет сделать
Пользователям необходимо научиться работать с большинством частей продукта. Практика описывает потребность в процедурных знаниях — в понимании того, как использовать продукт в обычной повседневной работе.
Признаки того, что документация этого не обеспечивает
- Одни и те же практические вопросы повторяются в службе поддержки и сообществах.
- Процедуры существуют только как неформальное знание команды или хранятся у кого-то в голове.
- Нет пошагового руководства по распространённым административным задачам.
Два примера из практики
Распространённые типы контента
| DITA | Diátaxis | Good Docs Project |
|---|---|---|
| <task>, <step>, <choicetable> | Практическое руководство | Практическое руководство |
Одна метрика
успешность задачи · Доля пользователей, которые выполняют стандартную процедуру без обращения в поддержку.