Aplicando Diátaxis
As páginas desta seção tratam de colocar o Diátaxis em prática.
O Diátaxis destina-se principalmente a ser uma abordagem pragmática para pessoas que trabalham com documentação. A maioria dos princípios fundamentais necessários para colocá-lo em prática com sucesso pode ser compreendida intuitivamente.
Não espere entender o Diátaxis antes de começar a tentar colocá-lo em prática. Você não apenas não precisa entender tudo para usá-lo, mas também não o entenderá até começar a usá-lo (este é, por si só, um princípio do Diátaxis).
Assim que sentir que pegou uma ideia que parece valer a pena aplicar ao seu trabalho, tente aplicá-la. Volte aqui quando precisar de mais clareza ou segurança. Intere entre o seu trabalho e a reflexão sobre o seu trabalho.
Nesta seção
No cerne do Diátaxis estão os quatro tipos diferentes de documentação que ele identifica. Se você está tendo contato com o Diátaxis pela primeira vez, comece por estas páginas.
-
Tutoriais - experiências orientadas ao aprendizado
-
Guias práticos - instruções orientadas a objetivos
-
Referência - descrição técnica orientada à informação
-
Explicação - discussão orientada à compreensão
O Diátaxis prescreve princípios que orientam a ação. Eles se traduzem em formas específicas de trabalhar, com implicações para o processo e a execução da documentação. Depois de dar o primeiro passo, as ferramentas e os métodos descritos aqui ajudarão a facilitar o seu caminho.
-
A bússola - uma ferramenta simples para orientação
-
Fluxo de trabalho no Diátaxis