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

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

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

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

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

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

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

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