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