Aplicando o Diátaxis
As páginas desta seção tratam de colocar o Diátaxis em prática.
O Diátaxis é primariamente destinado a ser uma abordagem pragmática para pessoas que trabalham com documentação. A maioria dos princípios-chave necessários para colocá-lo em prática com sucesso pode ser compreendida de forma intuitiva.
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 utilizá-lo, como também não o entenderá até começar a usá-lo (isso em si é um princípio do Diátaxis).
Assim que sentir que captou uma ideia que parece valer a pena ser aplicada ao seu trabalho, tente aplicá-la. Retorne aqui quando precisar de mais clareza ou segurança. Alterne entre o seu trabalho e a reflexão sobre o seu trabalho.
Nesta seção
No núcleo do Diátaxis estão os quatro tipos diferentes de documentação que ele identifica. Se você está encontrando o Diátaxis pela primeira vez, comece por estas páginas.
-
Tutoriais - experiências orientadas ao aprendizado
-
Guias de instruções - orientações orientadas a objetivos
-
Referência - descrição técnica orientada a informações
-
Explicação - discussão orientada à compreensão
O Diátaxis prescreve princípios que orientam a ação. Eles se traduzem em maneiras específicas de trabalhar, com implicações para o processo e a execução da documentação. Assim que você fizer o seu primeiro início, as ferramentas e os métodos descritos aqui ajudarão a suavizar o seu caminho.