Глоссарий

Действия

Оценить Распознать

Разобраться в основных качествах продукта и, если это уместно, сравнить его с другими. Пользователи документации — это также потенциальные клиенты или те, кто может внедрить продукт. Читатель должен уметь распознать основные качества продукта и сравнить его с другими. Это процесс открытия.

Понять Изучить

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

Исследовать Открыть

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

Практиковаться Тренироваться

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

Вспомнить Припомнить

Восстановить в памяти сведения, которые невозможно было запомнить: от параметров до кодов ошибок. Благодаря справочным материалам документация сохраняет ценность спустя годы. Пользователи просматривают руководства, чтобы вспомнить, извлечь или найти сведения, которые они не смогли запомнить.

Разрабатывать Интегрировать

Строить поверх продукта, расширять или интегрировать его, создавая дополнительную ценность. Пользователям часто нужно строить что-то поверх существующих продуктов, расширять или интегрировать их — с помощью интеграций, расширений, плагинов или совершенно новых приложений. Акцент почти всегда практический.

Устранить неполадки Решить

Быстро диагностировать и решать проблемы, часто в условиях давления. Проблемы из-за неверных настроек, пограничных случаев или настоящих ошибок — обычная часть пользовательского опыта. Устранение неполадок отражает потребность быстро диагностировать и решать проблемы, зачастую когда системы не работают или сроки поджимают.