Uma das práticas recomendadas ao lançar um novo produto é realizar os preparativos para o lançamento do produto. Em particular, queremos nos concentrar em escrever a documentação do novo produto para dar suporte ao lançamento do produto. Sem ela, os usuários em potencial não terão informações relevantes para usar como ponto de referência após a compra da sua nova solução.
Como parte de uma estratégia de marketing mais ampla, os gerentes de produtos e os membros da equipe de produtos devem continuar lendo para conhecer 15 práticas recomendadas a serem seguidas no próximo lançamento. Ao final, você entenderá como fazer com que esses importantes documentos sejam os melhores possíveis!
Que tipos de documentação de produto devo conhecer?
Antes de mergulhar na lista de práticas recomendadas, vamos esclarecer quais são os tipos de documentação de produtos existentes e o objetivo pretendido para cada um deles:
-
Documentação de requisitos do produto** - Um documento de requisitos do produto ou PRD é um tipo de documentação interna do produto usada para ajudar as empresas a atender aos critérios de lançamento. Ele explica o que o produto final deve realizar para um usuário, sem definir especificamente como ou onde. Em seguida, as equipes de desenvolvimento e as equipes de teste usam um PRD para alinhar o produto com os requisitos comerciais prontos para o lançamento. Os PRDs são comuns em produtos de software, mas podem ser usados para aderir a qualquer roteiro de produto.
-
Guias do usuário e autoatendimento** - As equipes de produtos precisarão criar guias do usuário como um pré-requisito para o lançamento bem-sucedido do produto. Como o nome sugere, trata-se de uma documentação para ajudar os usuários finais a maximizar sua produtividade ao usar um novo produto. Aqui, todas as principais funcionalidades voltadas para o usuário devem ser explicadas por completo, para que os clientes possam obter o máximo de valor. Melhor ainda, compartilhe esses guias em uma base de conhecimento externa de autoatendimento para que os clientes possam se ajudar!
-
Guias de configuração, instalação e configuração** - Se um produto exigir configuração, instalação e configuração, esse é outro ativo de documentação técnica do produto que você precisará criar. O objetivo é ilustrar claramente esses processos do ponto de vista do usuário e do desenvolvedor, se for o caso. Isso pode abranger vários dispositivos e vários sistemas operacionais, no caso de documentação de software, o que deve ser levado em conta.
Ativos de marketing - Você pode achar que isso não é documentação de produto, mas é! O estilo e o formato dos ativos de marketing influenciam a forma como os clientes percebem o seu produto, antes de começarem a usá-lo. É fundamental causar uma boa impressão. Causar uma boa impressão é fundamental. Como você está descrevendo os novos recursos do produto? A que público ele se destina? Como isso melhorará o trabalho ou a vida pessoal de alguém? É isso que você e a empresa em geral querem que os clientes pensem?
15 Práticas recomendadas para documentação no lançamento de novos produtos
Depois dessa cartilha sobre a documentação de produtos, a seguir temos a lista de práticas recomendadas:
1: Comece!
Está começando agora com a documentação do produto? Ótimo! Agora, não hesite em começar. Muitas pessoas querem que a documentação do produto seja PERFEITA e, na busca pela perfeição, ficam paralisadas pela tarefa. Coloque o conceito básico de seus serviços no papel e, em seguida, concentre-se em arrumá-los para impressionar seus clientes. As notas de versão são ótimas para definir os conceitos básicos e, em seguida, você pode desenvolver a partir desse documento.
2: Mantenha-o simples, estúpido...
Abreviado como KISS, esse é um princípio de design real que circulou (trocadilho intencional) na marinha dos EUA nos anos 60. A mesma regra pode ser aplicada à documentação do produto. Pergunte a si mesmo: "Como você pode transmitir as informações necessárias de uma forma que todos os grupos demográficos possam entender?"
Para aplicar isso à visão de seu produto, recomendamos o teste de legibilidade Flesch-Kincaid. Ferramentas de classificação de conteúdo, como a Grammarly, geralmente usam esse sistema. Isso lhe dá uma pontuação equivalente a uma nota do ensino médio dos EUA ao analisar o conteúdo escrito. Tenha como meta a 8ª série ou a idade de 13 a 14 anos como idade escolar para maximizar a interpretabilidade do conteúdo - espere, poderíamos ter dito... como é fácil entender sua redação.
3: Entenda o público-alvo
Então, você começou e manteve a simplicidade. Agora, você precisa saber para quem está escrevendo... Por exemplo, o público-alvo de empresas de software será muito diferente de um fabricante de automóveis.
Vamos imaginar uma empresa de software educacional que se concentra em ferramentas simples para ajudar os jovens estudantes a aprender passo a passo sobre conceitos. O primeiro pensamento em sua cabeça pode ser: "então, o público-alvo são as crianças, certo?". Não necessariamente... O público-alvo é o principal tomador de decisões para pacotes de software em um jardim de infância ou escola de ensino médio, como o departamento de TI e as partes interessadas internas responsáveis pela aquisição. Um público secundário seriam os jovens estudantes, que podem ver o software educacional na natureza e defender seu uso em sua escola.
4: Concentre-se no valor, em vez de em uma história
Embora todos gostem de uma boa história, os clientes querem saber o valor que seu produto oferecerá. Ele simplificará uma tarefa ou um fluxo de trabalho? Seu produto está disponível off-line, em comparação com os concorrentes que estão apenas on-line? Seu produto faz a coisa mais rapidamente do que outros produtos concorrentes?
Esses exemplos constituem pontos de venda exclusivos (USP) para uma determinada oferta. Concentrar-se e destacar os USPs tentará os clientes em potencial e os ajudará a entender o que você tem que os outros não têm para aumentar a participação no mercado. Você pode definir os USPs fazendo uma análise competitiva dos concorrentes em seu setor.
5: Aproveite a formatação para categorizar as informações
A documentação não deve ser um grande bloco de texto. Isso dificulta a leitura e a navegação dos usuários 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 quando clicam em uma página. H2 e H3 funcionam como subtítulos para os tópicos abordados na página. Você pode usar marcadores ou listas numeradas para agrupar o conteúdo para facilitar a leitura e até mesmo se qualificar para Rich Snippets para melhorar a visibilidade de SEO e SERPS. Se você tiver conhecimento de Markdown, um editor de Markdown on-line, como o Docsie, oferece várias opções de formatação para fazer com que os documentos do seu produto se destaquem!
6: Mantenha sua documentação em um local central
Não há nada pior do que liberar a documentação técnica e depois perceber como será complicado monitorá-la e gerenciá-la a longo prazo. E se a documentação precisar de uma atualização? Onde está o documento original e como podemos liberar novas versões da página? Que tal traduzir esse conteúdo para outros idiomas?
Para essa prática recomendada, temos que mencionar o Docsie! O software de base de conhecimento on-line permite armazenar documentos em um único local centralizado na nuvem. A partir daí, os funcionários e prestadores de serviços podem colaborar com o conteúdo para agilizar a conclusão pronta para o lançamento. A Docsie oferece gerenciamento de controle de versão quando é necessário atualizar o conhecimento e gerenciamento de idiomas para a localização global do conteúdo. Se você quiser automatizar a criação de conteúdo global, também temos um robô fantasma de tradução de idiomas com IA que traduz com precisão para você em segundo plano!
7: Uma imagem fala mais que mil palavras
Embora seja possível escrever uma longa explicação sobre como fazer algo, essa não é uma maneira eficaz de ensinar os usuários finais. Em vez disso, mostre a eles com imagens, ou até mesmo com imagens em movimento!
Tente criar um tutorial em vídeo para cada documento do produto. Dessa forma, aqueles que preferem ler podem ler o texto, enquanto os alunos visuais podem optar pelo vídeo. Da mesma forma, GIFs e imagens podem ajudar os usuários a ver a que você está se referindo, especialmente em uma interface de usuário (UI) de software. A adaptação a uma variedade de estilos de aprendizagem o ajudará a ajudar uma gama maior de usuários, o que significa mais potencial para o seu produto.
8: Aprendizado vs. Metas vs. Compreensão vs. Informações
Qual é a intenção do documento? A intenção do usuário é fundamental na documentação on-line do produto e ajuda a alinhar o conteúdo às seções da jornada do usuário.
-
Aprendizagem** - Se uma pessoa nunca viu algo antes, o conteúdo de aprendizagem a ajuda a entender os princípios básicos.
-
Objetivos** - Esse tipo de conteúdo deve ajudar os usuários a atingir um objetivo, como "Como exportar um arquivo PDF do Docsie". No final, o usuário terá alcançado o objetivo: exportar um PDF.
-
Entendimento** - Também chamado de pesquisa, destina-se a clientes que já têm conhecimento prático sobre um assunto, mas querem entender mais profundamente.
-
Informação** - O sujeito tem uma pergunta e deseja uma resposta específica. Pode ser algo simples como o clima em tempo real em um local específico ou um vídeo sobre "como construir uma casa na árvore".
9: Torne-o pesquisável
Antes de tornar essa documentação pública, seus usuários podem pesquisar palavras-chave no texto?
Caso contrário, recomendamos encontrar uma plataforma de documentação que ofereça suporte a isso. O principal impedimento para os usuários é não conseguir encontrar informações rapidamente. Isso gera frustração, cargas de trabalho adicionais para a equipe de suporte ao cliente, caso eles não consigam encontrar as informações, e uma experiência geral negativa para o cliente (CX). Ah, o Docsie oferece suporte à pesquisa global, caso você esteja se perguntando!
10: Preparação para coletar feedback acionável
Os redatores de documentação estarão cientes do fato de que a versão inicial do conteúdo deverá sofrer alterações no futuro. Até que o público veja a documentação, seus redatores só podem trocar ideias e feedbacks entre si.
Depois que a documentação for publicada, acreditamos que é essencial ter uma coleta de feedback em vigor. Dessa forma, seus redatores podem transformar quaisquer pontos negativos relacionados ao conteúdo em pontos positivos, ouvindo clientes reais e usuários finais. Não é preciso procurar em outro lugar, você pode aproveitar a coleta de feedback no Docsie!
11: Link para uma página ao mencionar um tópico
Essa prática recomendada se baseia em SEO e em estruturas de navegação de páginas da Web.
Quando você menciona uma palavra-chave, você faz um link para ela? Quando você faz referência a outros tópicos, os usuários podem ainda não entender o outro tópico no contexto da página atual. Você deve criar um link para todos os tópicos mencionados que tenham documentação, pois isso permite que os leitores consultem rapidamente os subtópicos enquanto aprendem sobre um tópico principal.
12: Clareza, não ambiguidade
A clareza supera a ambiguidade ao escrever a documentação do produto. Você pode usar o inglês simples para evitar a ambiguidade, o que basicamente significa evitar jargões e linguagem técnica, a menos que seja absolutamente necessário. Se você usar jargões, certifique-se de escrever uma definição simplificada logo em seguida para os leitores leigos.
"Se você estiver tendo problemas para compreender as informações desta documentação, solicite mais detalhes sobre como superar essa dificuldade de compreensão ao nosso representante de suporte ao cliente."
"Se o conteúdo exibido for difícil de entender, você pode pedir ajuda ao suporte ao cliente."
O que você prefere?
13: Crie modelos para tornar os documentos mais rápidos
Com o lançamento de um novo produto, agilizar o processo de criação da documentação é uma prioridade. Você pode fazer isso usando modelos.
Os modelos definem uma estrutura reutilizável para as páginas, ajudando os redatores a criar conteúdo com mais rapidez e consistência. Você também pode criar vários modelos para diferentes estilos de conteúdo. A Docsie oferece uma variedade de modelos pré-criados para você usar, além de suporte a modelos personalizados.
14: Estabeleça um tom de voz e um guia de estilo para os redatores
Qual é o grau de liberdade que seus redatores têm?
É importante controlar os redatores, pois isso pode levar a inconsistências nos rascunhos finais da documentação do produto. Você pode fazer isso com diretrizes de tom de voz (ToV) e guias de estilo de redação de conteúdo.
-
Tom de voz** - Não é o que você disse... é a maneira como você disse. Você quer que os redatores sejam formais e adequados ou mais informais? O humor é permitido ou os tópicos são mais sérios? O seu conteúdo é mais coloquial e apaixonado, ou você quer apenas fatos frios e duros?
-
Diretrizes de estilo** - Esse documento pode explicar a declaração de missão da empresa e como os redatores podem seguir um estilo definido ao escrever e formatar as páginas. Aqui podem estar incluídas as personas de usuário a serem segmentadas, os princípios de SEO, como meta descrições, e os requisitos de citação ou referência (Chicago, AP Style etc.).
15: Publique sua documentação usando uma plataforma poderosa de base de conhecimento
Se o seu conteúdo escrito é combustível, que veículo você está usando para transmitir a mensagem?
Uma plataforma avançada de base de conhecimento é essencial para implantar uma documentação de produto de qualidade. Se os documentos ficarem indisponíveis ou as páginas demorarem a carregar, todo o esforço despendido na criação desses documentos será desperdiçado.
É necessário ter a capacidade de importar documentos existentes, colaborar no conteúdo com equipes internas, criar e editar novos documentos, incorporar conteúdo dinâmico e rico e publicar em um site de conhecimento. O controle de versões também é essencial para atualizações de longo prazo da documentação, juntamente com o gerenciamento de idiomas e a tradução automática para a localização global do conteúdo.
Você adivinhou! Todos esses recursos estão disponíveis no Docsie. Dê uma olhada nesses recursos e experimente nosso plano Free Forever para começar!