Системный подход к созданию технической документации.
Диатаксис — это способ мышления и ведения документации.
Он предписывает подходы к содержанию, архитектуре и форме, которые вытекают из систематического подхода к пониманию потребностей пользователей документации.
Diátaxis выделяет четыре отдельные потребности и четыре соответствующие формы документации: обучающие программы, практические руководства, техническая справка и объяснение. Он ставит их в систематическую взаимосвязь и предлагает, чтобы документация сама была организована вокруг структур этих потребностей.
Diátaxis решает проблемы, связанные с документацией содержание (что написать), стиль (как это написать) и архитектура (как это организовать).
Diátaxis не только обслуживает пользователей документации, но и полезен для создателей и сопровождающих документацию. Он легкий, простой в использовании и простой в применении. Это не накладывает ограничений на реализацию. Он привносит в документацию активный принцип качества, который помогает сопровождающим эффективно думать о своей работе.
Содержание¶
Этот веб-сайт разделен на два основных раздела, которые помогут вам применять и понимать Diátaxis.
Начните здесь. Эти страницы помогут сразу и конкретно понять суть подхода.
В этом разделе более глубоко исследуются теория и принципы Диатаксиса, а также излагается понимание потребностей, лежащих в его основе.
Диатаксис доказан на практике. Его принципы были успешно использованы в сотнях проектов документации.
В Gatsby мы недавно реорганизовали нашу документацию с открытым исходным кодом, и платформа Diátaxis была нашим основным ресурсом на протяжении всего проекта. Четыре квадранта помогли нам расставить приоритеты целей пользователя для каждого типа документации. Реструктуризировав нашу документацию на основе платформы Diátaxis, мы упростили пользователям поиск необходимых им ресурсов, когда они им нужны.
При перепроектировании Документация разработчика CloudflareDiátaxis стала нашей северной звездой информационной архитектуры. Когда мы не были уверены, где должен разместиться новый фрагмент контента, мы сверялись с фреймворком. Наша документация теперь стала более понятной, чем когда-либо, как для читателей, так и для участников.
2024-12-05 04:35:00
1733375117
#Диатаксис