Resumo do Módulo 2

O Módulo 2 cobriu as seguintes lições intermediárias de redação técnica:

• Adote um guia de estilo.
• Pense como seu público.
• Leia documentos em voz alta (para você mesmo).
• Retorne aos documentos bem depois de escrever o rascunho.
• Encontre um bom editor para revisão em pares.
• Esboce um documento. Alternativamente, escreva de forma livre e depois organize.
• Dê uma introdução ao escopo de um documento e quaisquer pré-requisitos.
• Prefira títulos baseados em tarefas.
• Divulgue informações progressivamente (em algumas situações).
• Considere escrever a legenda antes de criar a ilustração.
• Restrinja a quantidade de informações em um único desenho.
• Concentre a atenção do leitor na parte relevante de uma imagem ou diagrama, descrevendo a ideia principal na legenda ou adicionando uma sugestão visual à imagem.
• Crie um código de exemplo conciso que seja fácil de entender.
• Mantenha os comentários de código curtos, mas prefira clareza à brevidade.
• Evite escrever comentários sobre código óbvio.
• Concentre sua energia de comentários em qualquer coisa não intuitiva no código.
• Forneça não apenas exemplos, mas também anti-exemplos.
• Forneça exemplos de código que demonstrem uma variedade de complexidade.
• Faça uma prática de revisão contínua.
• Forneça diferentes tipos de documentação para diferentes categorias de usuários.
• Compare e contraste com algo que os leitores já estão familiarizados.
• Nos tutoriais, reforce os conceitos com exemplos.
• Nos tutoriais, cite os problemas que os leitores podem encontrar.

O conteúdo desta página é uma tradução livre e adaptada. O material original está disponível em inglês no Google Developers sob a licença Creative Commons (CC BY 4.0).