Uma prática recomendada ao lançar um novo produto¶

Uma prática recomendada ao lançar um novo produto é realizar preparações para o lançamento. Em particular, queremos focar na criação de nova documentação para apoiar o lançamento. Sem ela, os potenciais utilizadores não terão informações relevantes para usar como referência após a compra da sua nova solução.

Como parte de uma estratégia de marketing mais ampla, os gestores de produto e membros da equipa devem continuar a ler para conhecer 15 boas práticas a seguir durante o próximo lançamento. No final, compreenderá como tornar estes documentos importantes os melhores possíveis!

Que tipos de documentação de produto devo conhecer?

Antes de mergulhar na lista de boas práticas, vamos esclarecer que tipos de documentação existem e qual o objetivo de cada um:

• Documentação de Requisitos do Produto – Um documento de requisitos ou PRD é um tipo de documentação interna usado para ajudar as empresas a cumprir critérios de lançamento. Este explica o que o produto final deve fazer para um utilizador, sem definir especificamente como ou onde. As equipas de desenvolvimento e teste usam um PRD para alinhar o produto com os requisitos de negócio para o lançamento. Os PRDs são comuns em produtos de software, mas podem ser usados para cumprir qualquer roteiro de produto.

• Guias do Utilizador e Autoatendimento – As equipas de produto precisam criar guias do utilizador como pré-requisito para um lançamento bem-sucedido. Como o nome sugere, esta documentação ajuda os utilizadores finais a maximizar a sua produtividade ao usar um novo produto. Aqui, todas as funcionalidades principais devem ser explicadas detalhadamente, para que os clientes obtenham o máximo valor. Melhor ainda, partilhe estes guias numa base de conhecimento externa para que os clientes possam ajudar-se a si próprios!

• Guias de Configuração, Instalação e Parametrização – Se um produto requer configuração, instalação e parametrização, este é outro ativo técnico que precisará criar. O objetivo é ilustrar claramente estes processos na perspetiva do utilizador e do programador, se aplicável. Isto pode abranger vários dispositivos e sistemas operativos, no caso da documentação de software – algo a ter em mente.

• Materiais de Marketing – Pode não pensar que isto seja documentação de produto, mas é! O estilo e formato dos materiais de marketing influenciam como os clientes percecionam o seu produto, antes de começarem a usá-lo. Causar uma boa impressão é vital. Como está a descrever as novas funcionalidades do produto? Para que público se destina? Como irá melhorar a vida profissional ou pessoal de alguém? É isto que você e a empresa querem que os clientes pensem?

Após esta introdução à documentação de produto, seguem-se as boas práticas:

1: Comece!¶

Está a começar com documentação de produto? Ótimo! Não hesite em dar o primeiro passo. Muitas pessoas querem que a documentação seja PERFEITA; e na busca da perfeição, ficam paralisadas pela tarefa. Coloque o conceito básico dos seus serviços no papel e depois concentre-se em organizar tudo para impressionar os seus clientes. As notas de lançamento são excelentes para definir o básico, e depois pode desenvolver a partir deste documento.

2: Mantenha-o Simples...¶

Conhecido como KISS (Keep It Simple, Stupid), este é um princípio de design real que circulou na marinha dos EUA nos anos 60. A mesma regra pode aplicar-se à documentação de produto. Pergunte a si mesmo: "Como posso transmitir a informação necessária de forma que todos os públicos possam entender?"

Para aplicar isto à sua visão de produto, recomendamos o teste de legibilidade Flesch-Kincaid. Ferramentas como o Grammarly usam frequentemente este sistema. Isto dá-lhe uma pontuação equivalente a um nível escolar dos EUA ao analisar conteúdo escrito. Procure atingir o nível 8 ou idade de 13 a 14 anos para maximizar a compreensibilidade do conteúdo – espere, poderíamos ter dito... facilitar a compreensão da sua escrita.

3: Compreenda o Público-Alvo

Já começou e manteve a simplicidade. Agora, precisa de saber para quem está realmente a escrever... Por exemplo, o público-alvo para empresas de software será muito diferente do de um fabricante automóvel.

Imaginemos uma empresa de software educativo focada em ferramentas simples para ajudar jovens estudantes a aprender passo a passo diversos conceitos. O primeiro pensamento pode ser: "então, o público-alvo são crianças, certo?". Não necessariamente... O público-alvo são os principais decisores de pacotes de software numa escola primária ou secundária – como o departamento de informática e responsáveis internos pelas aquisições. Um público secundário seriam os jovens estudantes, que podem ver o software educativo e defender a sua utilização na escola.

4: Foque-se no Valor, Não numa História

Embora todos gostem de uma boa história, os clientes querem saber que valor o seu produto oferecerá. Vai simplificar uma tarefa ou fluxo de trabalho? O seu produto está disponível offline, ao contrário dos concorrentes que são apenas online? O seu produto faz algo mais rápido que outros produtos concorrentes?

Estes exemplos constituem pontos únicos de venda (USP) para uma oferta específica. Focar e destacar os USPs tentará potenciais clientes e ajudá-los-á a entender o que você tem que outros não têm, aumentando a quota de mercado. Pode definir USPs realizando uma análise competitiva contra concorrentes no seu setor.

5: Utilize Formatação para Categorizar Informação

A documentação não deve ser um grande bloco de texto. Isto é difícil de percorrer e navegar para os utilizadores finais. Em vez disso, use títulos e outras opções de formatação para dividir o texto.

Os títulos H1 são a primeira coisa que as pessoas veem ao clicar numa página. H2 e H3 funcionam como subtítulos para tópicos abordados na página. Pode usar marcadores ou listas numeradas para agrupar conteúdo para facilitar a leitura, e até mesmo tornar-se elegível para Rich Snippets para melhorar o SEO e a visibilidade nos resultados de pesquisa. Se tiver conhecimentos de Markdown, um editor online como o Docsie oferece inúmeras opções de formatação para destacar a sua documentação de produto!

6: Mantenha a sua Documentação num Local Central

Não há nada pior do que lançar documentação técnica e depois perceber como será complicado monitorizá-la e geri-la a longo prazo. E se a documentação precisar de uma atualização? Onde está o documento original e como podemos lançar novas versões da página? E quanto à tradução deste conteúdo para outros idiomas?

Para esta boa prática, temos de mencionar o Docsie! O software de base de conhecimento online permite-lhe armazenar documentos num único local centralizado na nuvem. A partir daqui, funcionários e colaboradores podem colaborar no conteúdo para agilizar a conclusão antes do lançamento. O Docsie oferece gestão de controlo de versões quando precisa de atualizar conhecimentos e gestão de idiomas para localização global de conteúdo. Se quiser automatizar a criação de conteúdo global, também temos um bot de tradução por IA que traduz com precisão em segundo plano!

7: Uma Imagem Vale Mais que Mil Palavras

Embora escrever uma longa explicação sobre como fazer algo funcione, não é uma forma eficaz de ensinar os utilizadores finais. Em vez disso, mostre-lhes com imagens, ou até mesmo com imagens em movimento!

Tente criar um vídeo tutorial para cada documento do produto. Assim, aqueles que preferem ler podem percorrer o texto, enquanto os aprendizes visuais podem optar pelo vídeo. Da mesma forma, GIFs e imagens podem ajudar os utilizadores a ver a que se está a referir, especialmente dentro de uma interface de utilizador de software (UI). Acomodar uma variedade de estilos de aprendizagem ajudá-lo-á a auxiliar uma gama mais ampla de utilizadores, significando mais potencial para o seu produto.

8: Aprendizagem vs Objetivos vs Compreensão vs Informação

Qual é a intenção do documento? A intenção do utilizador é crítica com a documentação online do produto e ajuda-o a alinhar o seu conteúdo com secções da jornada do utilizador.

1. Aprendizagem – Se uma pessoa nunca viu algo antes, o conteúdo de aprendizagem ajuda-a a entender os princípios básicos.

2. Objetivos – Este tipo de conteúdo deve ajudar os utilizadores a atingir um objetivo, como 'Como Exportar um Ficheiro PDF do Docsie'. No final, o utilizador terá alcançado o objetivo: exportar um PDF.

3. Compreensão – Também referido como pesquisa, isto é para clientes que já têm conhecimento prático sobre um assunto, mas querem entender com mais profundidade.

4. Informação – O sujeito tem uma pergunta e quer uma resposta específica. Isto pode ser tão simples como o tempo em tempo real num local específico, ou um vídeo sobre 'como construir uma casa na árvore'.

9: Torne-a Pesquisável

Antes de tornar esta documentação pública, os seus utilizadores podem pesquisar palavras-chave dentro do texto?

Se não, recomendamos encontrar uma plataforma de documentação que suporte isso. O principal fator de dissuasão para os utilizadores é não conseguir encontrar informações rapidamente. Isto leva à frustração, cargas de trabalho adicionais para a equipa de suporte ao cliente se não encontrarem a informação, e uma experiência negativa geral do cliente (CX). Ah, o Docsie suporta pesquisa global, caso estivesse a perguntar-se!

10: Prepare-se para Recolher Feedback Acionável

Os redatores de documentação estarão cientes do facto de que a versão inicial do conteúdo está destinada a mudar ao longo do tempo. Até que o público veja a documentação, os seus redatores só podem trocar ideias e feedback entre si.

Uma vez publicada a sua documentação, acreditamos que é essencial ter um sistema de recolha de feedback. Dessa forma, os seus redatores podem transformar quaisquer aspetos negativos relacionados com o conteúdo em positivos, ouvindo clientes reais e utilizadores finais. Não precisa de procurar noutro lugar, pode aproveitar a recolha de feedback no Docsie!

11: Faça Ligação para uma Página ao Mencionar um Tópico

Esta boa prática incide sobre SEO e estruturas de navegação de páginas web.

Quando menciona uma palavra-chave, cria uma ligação para ela? Quando faz referência a outros tópicos, os utilizadores podem ainda não entender o outro tópico no contexto da página atual. Deve fazer ligação para quaisquer tópicos mencionados que tenham documentação, pois isso permite aos leitores referenciar rapidamente subtópicos enquanto aprendem sobre um tópico principal.

12: Clareza, Não Ambiguidade

A clareza supera a ambiguidade ao escrever documentação de produto. Pode usar linguagem simples para evitar ambiguidade, o que basicamente significa evitar jargão e linguagem técnica, a menos que seja absolutamente necessário. Se usar jargão, certifique-se de escrever uma definição simplificada imediatamente a seguir para leitores leigos.

"Se estiver a ter problemas com a compreensão da informação nesta documentação, solicite detalhes adicionais sobre como superar esta dificuldade de compreensão ao nosso representante de apoio ao cliente."

"Se o conteúdo exibido for difícil de entender, pode pedir ajuda ao apoio ao cliente."

Qual prefere?

13: Crie Modelos para Fazer Documentos Mais Rapidamente

Com um novo produto a ser lançado, agilizar o processo de criação de documentação é uma prioridade. Pode fazê-lo usando modelos.

Os modelos definem uma estrutura reutilizável para páginas, ajudando os redatores a criar conteúdo mais rápido e com mais consistência. Também pode criar vários modelos para diferentes estilos de conteúdo. O Docsie oferece uma variedade de modelos pré-construídos para usar, juntamente com suporte para modelos personalizados.

14: Estabeleça um Tom de Voz e Guia de Estilo para Redatores

Quanta liberdade têm os seus redatores?

Controlar os redatores é importante, pois a falta de controlo pode levar à inconsistência nas versões finais da documentação do produto. Pode fazê-lo com diretrizes de Tom de Voz (ToV) e guias de estilo de redação de conteúdo.

• Tom de Voz – Não é o que disse... é a forma como o disse. Quer que os redatores sejam formais e adequados, ou mais casuais? O humor é permitido, ou os tópicos são mais sérios? O seu conteúdo é mais conversacional e apaixonado, ou quer apenas factos concretos?

• Diretrizes de Estilo – Este documento pode explicar a declaração de missão da empresa e como os redatores podem seguir um estilo definido ao escrever e formatar páginas. Aqui podem ser incluídas personas de utilizador a atingir, princípios de SEO como meta descrições, e requisitos de citação ou referência (Chicago, AP Style, etc.).

15: Publique a sua Documentação Usando uma Poderosa Plataforma de Base de Conhecimento

Se o seu conteúdo escrito é combustível, que veículo está a usar para transmitir a mensagem?

Uma poderosa plataforma de base de conhecimento é essencial para implementar documentação de produto de qualidade. Se os documentos ficarem indisponíveis, ou as páginas demorarem a carregar, todo o esforço gasto na criação destes documentos será desperdiçado.

Precisa da capacidade de importar documentos existentes, colaborar no conteúdo com equipas internas, criar e editar novos documentos, incorporar conteúdo dinâmico e publicar num site de conhecimento. O controlo de versão também é crítico para atualizações de documentação a longo prazo, juntamente com a gestão de idiomas e tradução automática para localização global de conteúdo.

Adivinhou! Todas estas funcionalidades estão disponíveis no Docsie. Experimente estas funcionalidades, teste o nosso plano Gratuito para começar!