Close

Categorias

Writing guidelines template

por Atlassian

Documente os padrões e as melhores práticas de desenvolvimento de conteúdo da empresa

Usar template
Writing guidelines template

Your organization is growing, and as it does, you want to make sure everyone in your content design team is on the same page. Documenting writing patterns and guidelines can go a long way toward ensuring consistency. That’s where our writing guidelines template comes in: it gives you all the tools you need to capture content patterns and the thinking behind them, so writers across your organization can create effective and consistent assets.

Como usar o template writing guidelines

Etapa 1. Defina a voz e o tom

Você trabalhou duro para cultivar uma voz de marca original. Adaptar esta voz a diferentes contextos, para que você possa ter certeza de alcançar o tom correto, dá trabalho. Comece descrevendo o tipo de mensagem que você está querendo atingir com este padrão, então, descreva como os desenvolvedores de conteúdo devem ajustar a voz e o tom para escrever mensagens efetivas deste tipo. Se a voz da marca tem dimensões diferentes (por exemplo, a voz da marca Atlassian é ousada, otimista e prática, com humor), considere adicionar uma imagem para ilustrar como estas dimensões funcionam neste tipo de mensagem.

Etapa 2. Adote princípios (e mostre o trabalho)

A próxima etapa é identificar os princípios de escrita do padrão. Pense no que as pessoas que usam o produto estão tentando alcançar quando elas encontram este tipo de mensagem, além do que elas podem estar sentindo neste momento. Então, crie de 3–5 princípios que se comuniquem com estes objetivos e emoções. Inclua exemplos bons e ruins em cada princípio para ilustrar a ideia e explique o que torna cada exemplo bom ou ruim.

Etapa 2. Adote princípios (e mostre o trabalho)

Etapa 3. Compartilhe dicas

Se você está escrevendo um padrão de conteúdo, é provável que tenha muita experiência em escrever um tipo de mensagem. Use seu conhecimento para ensinar aos outros desenvolvedores de conteúdo as dicas e melhores práticas que você coletou ao longo do caminho. Estas dicas podem ser coisas a serem evitadas (como "5 armadilhas comuns em que os desenvolvedores de conteúdo caem"), ideias sobre como equilibrar princípios de escrita conflitantes ou abordagens criativas que já funcionaram para você no passado. Você pode até vincular pesquisas ou recursos externos para oferecer contexto adicional.


A Atlassian é uma empresa de software corporativo que desenvolve produtos para desenvolvedores de software, gerentes de projeto e gestão de conteúdo.

  • Content design glossary template

    Atlassian

    Content design glossary

    Teach writers how to use product names, industry terms, and other content with an A-Z guide.

  • Customer interview report template

    Atlassian

    Relatório de entrevista com o cliente

    Transforme as entrevistas com o cliente em dados com o último relatório de entrevista com o cliente.

  • Design component template

    Tony Starr

    Líder de Design de Conteúdo
    Atlassian

    Componente de design

    Documente os componentes do sistema de design com este template prático.