Uma das melhores práticas aquando do lançamento de um novo produto é a realização de preparativos para o lançamento do produto. Em particular, queremos concentrar-nos na redação da documentação do novo produto para apoiar o seu lançamento. Sem ela, os potenciais utilizadores não terão informações relevantes para utilizar como ponto de referência após a aquisição da sua nova solução.
Como parte de uma estratégia de marketing mais ampla, os gestores de produtos e os membros da equipa de produtos devem continuar a ler para conhecer 15 práticas recomendadas a seguir durante o seu próximo lançamento. No final, ficará a saber como tornar estes documentos importantes no melhor possível!
Que tipos de documentação de produto devo conhecer?
Antes de mergulhar na lista de práticas recomendadas, vamos esclarecer quais os tipos de documentação de produtos existentes e o objetivo pretendido para cada um:
-
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. Este documento explica o que o produto final deve realizar para um utilizador, sem definir especificamente como ou onde. Em seguida, as equipas de desenvolvimento e as equipas de teste utilizam um PRD para alinhar o produto com os requisitos comerciais prontos para lançamento. Os PRDs são comuns nos produtos de software, mas podem ser utilizados para aderir a qualquer roteiro de produto.
-
Guias do utilizador e autosserviço** - As equipas de produtos terão de criar guias do utilizador como pré-requisito para um lançamento de produto bem sucedido. Tal como o nome sugere, trata-se de documentação para ajudar os utilizadores finais a maximizar a sua produtividade quando utilizam um novo produto. Aqui, todas as principais funcionalidades para o utilizador devem ser explicadas na íntegra, para que os clientes possam obter o máximo valor. Melhor ainda, partilhe estes guias numa base de conhecimentos externa de autosserviço para que os clientes possam ajudar-se a si próprios!
-
Guias de configuração, instalação e configuração** - Se um produto requerer configuração, instalação e configuração, este é outro ativo de documentação técnica do produto que terá de criar. O objetivo é ilustrar claramente estes processos na perspetiva do utilizador e do programador, se aplicável. Isto pode abranger vários dispositivos e vários sistemas operativos se se tratar de documentação de software; algo a ter em conta.
-
Activos de marketing** - Pode não pensar que isto é documentação do produto, mas é! O estilo e o formato dos activos de marketing influenciam a forma como os clientes percepcionam o seu produto, antes de o começarem a utilizar. Causar uma boa impressão é vital. Como está a descrever as novas funcionalidades do produto? A que público se destina? Como é que este produto vai melhorar o trabalho ou a vida pessoal de alguém? É isto que você e a empresa em geral querem que os clientes pensem?
15 Práticas recomendadas para a documentação aquando do lançamento de novos produtos
Depois dessa cartilha sobre documentos de produtos, o próximo passo é a lista de melhores práticas:
1: Comece!
Está a começar a trabalhar com documentação de produtos? Ótimo! Agora, não hesite em começar. Muitas pessoas querem que a documentação do produto seja PERFEITA; e, na busca da perfeição, ficam paralisadas pela tarefa. Coloque o conceito básico dos seus serviços no papel e, em seguida, concentre-se em arrumar tudo para impressionar os seus clientes. As notas de lançamento são óptimas para definir os conceitos básicos e, em seguida, pode construir a partir deste documento.
2: Mantenha-o simples, estúpido...
Abreviado como KISS, este é um princípio de design real que flutuou (trocadilho intencional) na marinha dos EUA nos anos 60. A mesma regra pode ser aplicada à documentação do produto. Pergunte a si próprio: "Como é que se pode transmitir a informação necessária de uma forma que todos os grupos demográficos possam compreender?"
Para aplicar isto à visão do seu produto, recomendamos o teste de legibilidade Flesch-Kincaid. As ferramentas de classificação de conteúdos, como o Grammarly, utilizam normalmente este sistema. Isto dá-lhe uma pontuação equivalente a uma nota do ensino secundário dos EUA ao analisar o conteúdo escrito. O objetivo é obter o 8º ano ou os 13 a 14 anos como idade de escolaridade para maximizar a interpretabilidade do conteúdo - espere, podíamos ter dito... a facilidade de compreensão da sua escrita.
3: Compreender o público-alvo
Então, começou, e manteve-o simples. Agora, precisa de saber para quem está a escrever... Por exemplo, o público-alvo das empresas de software será muito diferente do de um fabricante de automóveis.
Imaginemos uma empresa de software educativo que se concentra em ferramentas simples para ajudar os jovens estudantes a aprender conceitos passo a passo. O primeiro pensamento na 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 responsável pelas decisões relativas a pacotes de software num jardim de infância ou numa escola secundária - 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 educativo em ação e defender a sua utilização na sua escola.
4: Concentre-se no valor, em vez de numa história
Embora toda a gente adore uma boa história, os clientes querem saber o valor que o seu produto vai oferecer. Ele simplificará uma tarefa ou um fluxo de trabalho? O seu produto está disponível offline, em comparação com os concorrentes que estão apenas online? O seu produto faz a coisa mais rapidamente do que outros produtos concorrentes?
Estes exemplos constituem pontos de venda únicos (USP) para uma determinada oferta. Concentrar-se nos PSU e realçá-los irá seduzir os potenciais clientes e ajudá-los a compreender o que tem que os outros não têm para aumentar a quota de mercado. Pode definir os PSU através de uma análise competitiva dos concorrentes do seu sector.
5: Aproveite a formatação para categorizar as informações
A documentação não deve ser um grande bloco de texto. Isto é difícil de analisar e navegar para os utilizadores finais. Em vez disso, utilize 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 vêem quando clicam numa página. Os títulos H2 e H3 funcionam como subtítulos para os tópicos abordados na página. Pode utilizar marcadores ou listas numeradas para agrupar o conteúdo para facilitar a leitura e até ser elegível para Rich Snippets para melhorar a visibilidade SEO e SERPS. Se tiver conhecimentos de Markdown, um editor de Markdown online como o Docsie oferece inúmeras opções de formatação para destacar os documentos do seu produto!
6: Mantenha sua documentação em um local central
Não há nada pior do que lançar documentação técnica e depois perceber como será complicado monitorizar e gerir a longo prazo. E se a documentação precisar de uma atualização? Onde está o documento original e como é que podemos lançar novas versões da página? E que tal traduzir este conteúdo para outras línguas?
Para esta boa prática, temos de mencionar o Docsie! O software de base de conhecimentos em linha permite-lhe armazenar documentos numa única localização centralizada na nuvem. A partir daqui, os funcionários e os contratantes podem colaborar no conteúdo para acelerar a conclusão pronta para o lançamento. A Docsie oferece gestão de controlo de versões quando é necessário atualizar conhecimentos e gestão de idiomas para localização global de conteúdos. Se pretender automatizar a criação de conteúdos globais, também temos um robô de tradução linguística com IA fantasma que traduz com precisão para si em segundo plano!
7: Uma imagem fala mais do que mil palavras
Embora escrever uma longa explicação sobre como fazer uma coisa funcione, não é uma forma eficaz de ensinar os utilizadores finais. Em vez disso, mostre-lhes com imagens, ou mesmo com imagens em movimento!
Tente criar um tutorial em vídeo para cada documento do produto. Desta forma, os utilizadores que preferem ler podem ler o texto, enquanto os aprendizes visuais podem optar pelo vídeo. Da mesma forma, os GIFs e as imagens podem ajudar os utilizadores a ver a que se refere, especialmente numa interface de utilizador (IU) de software. A adaptação a uma série de estilos de aprendizagem ajudá-lo-á a ajudar um maior número de utilizadores, o que significa um maior potencial para o seu produto.
8: Aprendizagem vs Objectivos vs Compreensão vs Informação
Qual é a intenção do documento? A intenção do utilizador é fundamental na documentação de produtos online e ajuda-o a alinhar o seu conteúdo com as secções do percurso do utilizador.
-
Aprendizagem** - Se uma pessoa nunca viu algo antes, o conteúdo de aprendizagem ajuda-a a compreender os princípios básicos.
-
Objectivos** - Este tipo de conteúdo deve ajudar os utilizadores a atingir um objetivo, tal como "Como exportar um ficheiro PDF a partir do Docsie". No final, o utilizador terá atingido o objetivo: exportar um PDF.
-
Compreensão** - Também designada por pesquisa, destina-se a clientes que já têm conhecimentos práticos sobre um assunto, mas que pretendem aprofundar os conhecimentos.
-
Informação** - O sujeito tem uma pergunta e pretende uma resposta específica. Pode ser algo 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-o pesquisável
Antes de tornar esta documentação pública, os seus utilizadores podem pesquisar palavras-chave no texto?
Se não, recomendamos encontrar uma plataforma de documentação que suporte isso. O principal impedimento para os utilizadores é não poderem encontrar informações rapidamente. Isto leva à frustração, a cargas de trabalho adicionais da equipa de apoio ao cliente se não conseguirem encontrar a informação e a uma experiência global negativa do cliente (CX). Ah, o Docsie suporta a pesquisa global, caso esteja a pensar nisso!
10: Preparação para recolher feedback acionável
Os redactores de documentação estarão cientes do facto de que a versão inicial do conteúdo está sujeita a alterações ao longo do tempo. Até que o público veja a documentação, seus redatores só podem trocar idéias e feedback entre si.
Assim que a documentação for publicada, consideramos essencial que exista uma recolha de feedback. Dessa forma, os seus redactores podem transformar quaisquer aspectos negativos relacionados com o conteúdo em aspectos positivos, ouvindo os clientes reais e os utilizadores finais. Não precisa de procurar noutro lado, pode tirar partido da recolha de feedback no Docsie!
11: Ligar a uma página quando se menciona um tópico
Esta prática recomendada está relacionada com SEO e estruturas de navegação de páginas web.
Quando menciona uma palavra-chave, faz uma ligação à mesma? Quando faz referência a outros tópicos, os utilizadores podem ainda não compreender o outro tópico no contexto da página atual. Deve ligar a quaisquer tópicos mencionados que tenham documentação, uma vez que isto permite aos leitores referirem rapidamente sub-tó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 o jargão e a linguagem técnica, a menos que seja absolutamente necessário. Se você usar jargão, certifique-se de escrever uma definição simplificada imediatamente após para leitores leigos.
"Se tiver problemas em compreender as informações contidas nesta documentação, solicite mais informações sobre como ultrapassar esta dificuldade de compreensão ao nosso representante de apoio ao cliente."
"Se o conteúdo apresentado for difícil de compreender, pode pedir ajuda ao apoio ao cliente."
Qual é que prefere?
13: Criar modelos para tornar os documentos mais rápidos
Com o lançamento de um novo produto, agilizar o processo de criação de documentação é uma prioridade. Você pode fazer isso usando modelos.
Os modelos definem uma estrutura reutilizável para as páginas, ajudando os redactores a criar conteúdo mais rapidamente e com mais consistência. Também pode criar vários modelos para diferentes estilos de conteúdo. A Docsie oferece uma gama de modelos pré-construídos para utilização, bem como suporte para modelos personalizados.
14: Estabelecer um tom de voz e um guia de estilo para os redactores
Qual é o grau de liberdade que os seus redactores têm?
É importante controlar os redactores, pois isso pode levar a inconsistências nos rascunhos finais da documentação do produto. Pode fazê-lo com directrizes de tom de voz (ToV) e guias de estilo de escrita de conteúdos.
-
Tom de voz** - Não é o que disse... é a forma como o disse. Pretende que os redactores sejam formais e correctos, ou mais informais? O humor é permitido, ou os temas são mais sérios? O seu conteúdo é mais conversacional e apaixonado, ou quer apenas factos frios e duros?
-
Directrizes de estilo** - Este documento pode explicar a declaração de missão da empresa e como os redactores podem seguir um estilo definido ao escrever e formatar as páginas. Aqui podem ser incluídas as personas dos utilizadores a atingir, os princípios de SEO, como as meta descrições, e os requisitos de citação ou referência (Chicago, AP Style, etc.).
15: Publique a sua documentação utilizando uma poderosa plataforma de base de conhecimentos
Se o seu conteúdo escrito é combustível, que veículo está a utilizar para transmitir a mensagem?
Uma plataforma de base de conhecimento poderosa é essencial para a implantação de 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 desses documentos será desperdiçado.
É necessário ter a capacidade de importar documentos existentes, colaborar em conteúdos com equipas internas, criar e editar novos documentos, incorporar conteúdos dinâmicos e publicar num sítio de conhecimento. O controlo de versões também é essencial para actualizações de documentação a longo prazo, juntamente com a gestão de idiomas e a tradução automática para a localização global de conteúdos.
Adivinhou! Todas estas funcionalidades estão disponíveis no Docsie. Experimente estas funcionalidades, experimente o nosso plano Free Forever para começar!