Como escrevemos a documentação
Entenda como a documentação é produzida: a toolchain e suas verificações, os dois idiomas de cada página e os leitores para quem ela é escrita.
Como a documentação é produzida: a toolchain que a verifica, os dois idiomas em que ela é publicada e os leitores que ela atende.
- Docs as code - o repositório público, o fluxo de revisão e as verificações que toda mudança passa.
- Dois idiomas, uma fonte - o inglês como fonte de verdade e o par em português que toda página tem.
- Para pessoas e agentes - as escolhas de design que mantêm as páginas úteis para um leitor humano e para um sistema de retrieval.