Esses conceitos básicos são necessários para a documentação do . Use as listas abaixo para ajudar a garantir que suas contribuições sejam precisas, acessíveis, inclusivas e consistentes.
A documentação está correta e precisa.
- Verifique se o conteúdo está livre de erros factuais.
- Verifique se o conteúdo está livre de erros de ortografia e formatação.
A documentação está atualizada com os padrões de acessibilidade mais recentes e foi escrita de modo a ser inclusiva e amigável à tradução.
- Verifique se o conteúdo segue as diretrizes de acessibilidade e captura de tela. Para saber mais, confira Como criar capturas de tela.
- Verifique se o conteúdo pode ser traduzido com êxito. Para saber mais, confira Como escrever um conteúdo para tradução.
A documentação mantém uma voz, um tom e um estilo consistentes a todo momento, criando uma experiência coesa para os leitores.
- Verifique se o conteúdo segue o guia de estilo do Docs. Para saber mais, confira Guia de estilo.
- Aplique convenções de nomenclatura e terminologia consistentes.
- Use elementos de identidade visual (por exemplo, nomes de produtos e recursos, logotipos, esquemas de cores) consistentemente no conteúdo.