Orientação de escrita para a documentação da Adobe

Essas orientações se aplicam se você estiver criando uma nova documentação ou atualizando uma documentação existente.

Faça o seguinte:

  • Verifique a ortografia e a gramática nos artigos.
  • Use um tom amigável.
  • Use frases simples. Elas são mais fáceis de entender e traduzir para outros idiomas.

Diretrizes de estilos

Lembre-se do seguinte ao escrever uma documentação:

  • Escreva de maneira concisa: não desperdice palavras. Mantenha as frases curtas e concisas. Mantenha o foco do artigo. Reduza o número de notas.
  • Concentre-se no público-alvo e na finalidade: antes de começar a escrever, determine claramente quem é o cliente e qual é a tarefa ele está tentando realizar. Escreva seu artigo para ajudar o cliente a executar essa tarefa.
  • Use exemplos: forneça exemplos para explicar os conceitos.
  • Organize o conteúdo: crie seções para dividir as instruções em grupos de etapas mais controláveis. Use uma captura de tela para esclarecer pontos.

Nesta página