The compass
O mapa Diátaxis é um lembrete eficaz dos diferentes tipos de documentação e sua relação, além de se alinhar bem às intuições sobre documentação.
No entanto, nem sempre se deve confiar na intuição. Frequentemente, ao trabalhar com documentação, um autor depara-se com a pergunta: que forma de documentação é esta? ou que forma de documentação é necessária aqui? - e nenhuma resposta óbvia e intuitiva surge.
Pior ainda, às vezes a intuição fornece uma resposta imediata que também está errada.
Um mapa é mais poderoso em territórios desconhecidos quando também temos uma bússola para nos guiar.
A bússola Diátaxis é algo semelhante a uma tabela-verdade ou árvore de decisão da documentação. Ela reduz um problema bidimensional mais complexo às suas partes mais simples e fornece ao autor uma ferramenta de correção de rumo.
| Se o conteúdo... | ...e atende ao... | ...então deve pertencer a... |
|---|---|---|
| informa a ação | aquisição de habilidade | um tutorial |
| informa a ação | aplicação de habilidade | um guia prático |
| informa a cognição | aplicação de habilidade | referência |
| informa a cognição | aquisição de habilidade | explicação |
A bússola pode ser aplicada igualmente a situações de usuários que precisam de documentação ou à própria documentação que talvez precise ser movida ou melhorada. Como muitas boas ferramentas, ela é surpreendentemente banal.
Para usar a bússola, apenas duas perguntas precisam ser feitas: ação ou cognição? aquisição ou aplicação?
E ela produz a resposta.
Usando a bússola
A bússola é particularmente eficaz quando você acha que você (ou até mesmo a documentação à sua frente) está fazendo uma coisa - mas é incomodado por uma sensação de dúvida ou por alguma dificuldade no trabalho. A bússola força você a parar e reconsiderar.
Especialmente quando estiver tentando encontrar sua orientação inicial, use os termos da bússola com flexibilidade; não se fixe nos nomes exatos.
-
ação: etapas práticas, execução
-
cognition: conhecimento teórico ou proposicional, pensamento
-
aquisição: estudo
-
aplicação: trabalho
E as próprias perguntas também podem ser usadas de diferentes maneiras:
-
Acho que estou escrevendo para x ou y?
-
Este texto à minha frente está envolvido em x ou y?
-
O usuário precisa de x ou y?
-
Quero x ou y?
E tente aplicá-las de perto, ao nível de frases e palavras, ou de uma perspectiva mais ampla, considerando um documento inteiro.