Применение Diátaxis

Страницы этого раздела посвящены применению Diátaxis на практике.

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

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

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

В этом разделе

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

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