Anúncios

Templates

Anúncios

Um anúncio informa os usuários sobre novos recursos, melhorias, correções de bugs e outras atualizações de produtos e sistemas. Neste guia, você verá diretrizes gerais, o modelo de um anúncio e exemplos.

Revise as diretrizes em Melhores práticas para escrever documentação.

Como escrever um anúncio

Tópico	Descrição
Introdução	Comece o primeiro parágrafo com uma visão geral, explicando a mudança e seu impacto significativo para lojistas ou clientes. Deixe claro para o leitor já no início como o que está sendo anunciado afetará as operações de sua loja. Informe a região (por exemplo, Global, Brasil, LATAM, APAC, EUA ou EMEA) e a fase do produto (beta, alfa ou disponibilidade geral) na introdução.
Títulos	Garanta que todos os títulos estejam seguindo o padrão textual em todos os locales.
"O que mudou?"	Explique o caso de uso.
"Por que fizemos essa mudança?"	Explique o que motivou a VTEX a realizar a mudança e faça uma lista com itens para explicar os problemas solucionados.
"O que precisa ser feito?"	Oriente os leitores sobre como aproveitar esses novos recursos o mais rápido possível. Adicione um link de call-to-action que direcione o leitor para mais informações.

Modelo de anúncio

Modelo de anúncio


# Nome da funcionalidade + benefício
Criamos/modificamos esta funcionalidade para <incluir o principal benefício> permitindo que você <tarefa a ser realizada>. Ela está disponível em <alpha, beta, para um país específico ou para todos os usuários (disponibilidade geral)>.
## O que mudou?
Antes, você precisava/era necessário <como o usuário resolvia o problema>. Agora, você pode/é possível usar <novo botão/tela> para <benefício>.
## Por que fizemos essa mudança?
Para <facilitar a tarefa a ser realizada>, desenvolvemos <assunto>. Este recurso está disponível para <usuários específicos ou todos os usuários?> no <nome do módulo>. Suas principais vantagens são:
- Benefício 1
- Benefício 2
- Benefício 3
## O que precisa ser feito?
Para <usar este novo recurso>, você deve <instalar algo, ajustar uma configuração ou acessar um menu>.
Para saber mais <sobre o recurso/módulo/produto>, confira <o artigo/a trilha>.

Veja exemplos de artigos de anúncio no Help Center.