Фонды

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

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

В противном случае это будет просто еще один полезный эвристический подход, и самое сильное утверждение, которое мы можем сделать в его пользу, — это то, что «похоже, что он работает довольно хорошо».

Два измерения ремесла

Diátaxis основан на том принципе, что документация должна служить потребностям пользователей. Знание того, как это сделать, означает понимание потребностей пользователей.

Пользователь, чьи потребности обслуживает Diátaxis, — практик в области навыков. Область навыков определяется ремеслом: использование инструмента или продукта является ремеслом. То же самое можно сказать и о целой дисциплине или профессии. Использование языка программирования — это ремесло, как и управление конкретным самолетом или даже работа пилотом в целом.

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

Действие/познание

Навык, ремесло или практика содержат как действие (практические знания, знание как, что мы делаем), так и познание (теоретические знания, знание что, что мы думаем). Эти двое полностью связаны друг с другом, но они являются двойниками, совершенно отличными друг от друга, двумя разными аспектами одной и той же вещи.

Приобретение/применение

Точно так же отношения практикующего со своей практикой таковы, что это должно быть одновременно приобретенный и применяемый. «Работа» (забота о применении навыков и знаний своего ремесла) и «учеба» (забота о их приобретении) снова являются двойниками, разными, но связанными друг с другом.

Карта территории

Это дает нам два измерения мастерства, которые мы можем отобразить на карте – карте территории ремесла:

Это карта полный. Есть только два измерения, и они не просто охватывают всю территорию, они определяют ее. Вот почему в нем обязательно четыре четверти, а не три и не пять. Это не произвольное число.

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

Обслуживание потребностей

Карта территории крафта – это то, что дает нам знакомая Diátaxis карта документации. Карта, по сути, является ответом на вопрос: что должна делать документация, чтобы соответствовать этим качествам навыков, и на какие нужды она ориентирована в каждом конкретном случае?

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

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

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

Вот почему учебные пособия, практические руководства, ссылки и объяснения Diátaxis представляют собой полный перечень типов документации, которая может помочь практикующим специалистам. Вот почему существует четыре и только четыре типа документации. Другой территории, которую можно было бы прикрыть, просто нет.