Escrevendo Documentação de Programação Excelente: Um Guia de Ensino
Este artigo usa metáforas envolventes e narrativa para ilustrar a filosofia de escrever documentação técnica de alta qualidade. O autor argumenta que o cerne da documentação é o 'ensino', e não simplesmente fornecer informações. O artigo critica a inadequação de depender apenas do código-fonte, testes ou ferramentas de programação literária, enfatizando que a documentação deve ser vista como um processo de aprendizagem gradual, guiando os usuários do contato inicial e início rápido para a aprendizagem aprofundada e, finalmente, para a referência avançada. Cada etapa deve ser cuidadosamente projetada para ajudar os usuários a se tornarem especialistas. O autor também compartilha experiências pessoais de ensino e sugere tratar a redação de documentação como um processo de ensino, focando na experiência do usuário e na aquisição gradual de conhecimento.
Leia mais