Компас

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

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

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

На незнакомой территории карта особенно полезна, если у нас есть ещё и компас, который указывает направление.

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

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

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

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

Этого достаточно, чтобы получить ответ.

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

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

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

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

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

• освоение: учёба

• применение: работа

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

• Я считаю, что пишу для x или для y?

• Этот текст передо мной относится к x или к y?

• Пользователю требуется x или y?

• Я хочу x или y?

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