Компас

Карта Diátaxis является эффективным напоминанием о различных видах документации и их взаимосвязях, а также хорошо согласуется с интуитивными представлениями о документации.

Однако не всегда следует полагаться на интуицию. Часто при работе с документацией автор сталкивается с вопросом: что это за форма документации? или какая форма документации здесь необходима? — и нет очевидного, интуитивного ответа.

Хуже того, иногда интуиция дает немедленный ответ, который тоже неверен.

Карта наиболее эффективна на незнакомой территории, когда у нас есть компас, который будет вести нас.

Компас Diátaxis — это что-то вроде таблицы истинности или дерева решений документации. Он сводит более сложную двумерную проблему к ее более простым частям и предоставляет автору инструмент для корректировки курса.

Если контент…	…и обслуживает пользователя…	…тогда оно должно принадлежать…
информирует о действиях	приобретение навыков	учебник
информирует о действиях	применение навыков	практическое руководство
информирует познание	применение навыков	ссылка
информирует познание	приобретение навыков	объяснение

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

Чтобы использовать компас, нужно задать всего два вопроса: действие или познание? приобретение или применение?

И это дает ответ.

Использование компаса

Компас особенно эффективен, когда вы думаете, что вы (или даже документация перед вами) делаете одно дело — но вас беспокоит чувство сомнения или какая-то трудность в работе. Компас заставляет вас остановиться и пересмотреть свое решение.

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

• действие: практические шаги, выполнение

• познание: теоретическое или пропозициональное знание, мышление.

• приобретение: исследование

• приложение: работа

Да и сами вопросы тоже можно использовать по-разному:

• Думаю ли я, что пишу для х или й?

• Это письмо передо мной занято х или й?

• Нужен ли пользователю х или й?

• Хочу ли я х или й?

И попробуйте применить их крупным планом, на уровне предложений и слов, или в более широкой перспективе, рассматривая весь документ.