Я немного не согласен с этим. Существует разная глубина контента помощи, который можно создать. Если следовать модели Diátaxis, то это учебные пособия, практические руководства, справочные материалы и объяснения.
Учебные пособия, вероятно, стоит размещать в самом приложении, чтобы, заходя на страницу с намерением «Я хочу узнать, как это работает», вы могли разобраться, даже если страница сама по себе неочевидна. Возможно, даже создать центр обучения, который по сути позволит вам пройти курс по использованию программного обеспечения, если вы того пожелаете.
С остальными тремя категориями я не совсем согласен.
Если я перехожу на страницу настроек категорий, там может быть 20 разных действий, которые я хочу выполнить. Размещение практического руководства там привело бы к списку, который мне пришлось бы искать — и поскольку я ожидаю, что то, что я ищу, не обязательно будет иметь отдельную статью-руководство, я, скорее всего, введу этот вопрос в Google, вместо того чтобы просматривать список.
Ссылки на внешние справочные материалы — это проклятие, с которым мне приходится сталкиваться ежедневно. У нас есть «справочное руководство», которое рассказывает, что делает каждый ползунок и кнопка, вплоть до:
Кнопка «Отмена»: Закрывает диалоговое окно без применения изменений.
Кнопка «ОК»: Закрывает диалоговое окно, применяя изменения.
Использование этого справочника означает, что вам приходится прокручивать очень много технической информации, прежде чем вы дойдете до своего раздела, тогда как на самом деле вам нужен был всплывающий подсказка, которая перефразирует опцию несколькими дополнительными словами.
Если я попробую удалить категорию, текущее поведение почти идеально. Я вижу кнопку, обычно серую, но с вопросительным знаком, и если я нажимаю на неё, появляется сообщение:
Невозможно удалить эту категорию, так как в ней есть подкатегории.
или:
Невозможно удалить эту категорию, так как в ней 25852 темы. Самая старая тема…
Поведение хорошее: я понимаю, что не так и каков мой следующий шаг — удалить кучу сообщений и подкатегорий. Это не улучшилось бы, если бы вместо этого была ссылка на практическое руководство «Как удалить категорию».
Конечно, это всё ещё временное решение реальной проблемы: Почему система не позволяет мне удалить категорию с сообщениями внутри? Я могу удалять папки с подпапками и файлами в своей системе, почему же я не могу удалять категории с подкатегориями и сообщениями? Если бы не было этих странных ограничений, вообще не возникло бы необходимости в практическом руководстве внутри приложения.
И наконец, объяснения — это то, что представляет собой статья в блоге «Понимание уровней доверия». Когда я впервые с ней столкнулся, она была довольно запутанной: «Неужели случайная статья в блоге шестилетней давности — это лучшее, что у вас есть в качестве документации?» — и она ссылается на статью-справочник, в которой всё перечислено в таблице, что больше соответствовало моим ожиданиям (хотя и не в том порядке, который я ожидал). Объяснения не помогают мне напрямую выполнить задачу, поэтому размещать их там, где должна выполняться задача, не очень эффективно.
Я считаю, что в конечном итоге, хотя документация важна в нескольких местах (например, при вводе в систему или в случаях, когда дизайн не справляется), именно дизайн должен быть главным приоритетом. Чтение или просмотр видео, в котором кто-то объясняет вам работу сайта, редко является желаемым опытом.