Essa gafe me ensinou que eu precisava olhar para o nosso produto pelo prisma do cliente. Então, o proverbial interruptor de luz se "acendeu". Se eu fornecer um produto que atenda aos pontos problemáticos do cliente e o apoiar com documentação profissional do produto, teremos um vencedor.
E também descobri que criar uma documentação de produto profissional, esteticamente agradável e fácil de ler não era uma tarefa fácil. Mas, quando feita corretamente, a documentação do produto pode deixar os clientes satisfeitos e, por fim, aumentar a receita.
Quais são as práticas recomendadas para criar uma documentação profissional do produto?
Essas práticas recomendadas criam uma documentação de produto esteticamente agradável, informativa e fácil de usar. Seguir essas diretrizes o ajudará a fornecer uma documentação de produto que pode transformar um bom cliente em um ótimo cliente. E clientes excelentes acabam ajudando as empresas a aumentar as receitas, sendo a documentação do produto um componente vital da experiência do cliente.
1. Entenda seu público-alvo e dê a ele o que ele deseja
É essencial saber quais são as expectativas de seu público. Por exemplo, a documentação do produto é destinada a administradores ou a usuários finais? O escopo do seu público-alvo pode exigir uma redação técnica para administradores ou em termos e instruções claramente definidos para o usuário final.
Uma prática recomendada para criar documentação profissional do produto é entender as expectativas do cliente no nível do administrador ou do usuário final. Alguns dos métodos para coletar informações de identificação do público são:
-
Questionários e pesquisas
-
Feedback do público percebido
-
Brainstorming da empresa
-
Feedback sobre opiniões populares de clientes
-
Discussões em mesas redondas com clientes
2. Criar um plano de documentação como uma prática recomendada
Escrever um plano de documentação pode ajudar a visualizar possíveis gargalos durante a implementação do projeto. Criar a documentação do produto pode ser um desafio, e uma prática recomendada é criar um plano de documentação para ajudar a prever os problemas que podem surgir durante o processo de documentação.
Entre os benefícios da criação de um plano de documentação estão os seguintes:
Itens acionáveis- Auditar qualquer documentação existente para salvar informações aplicáveis que possam ser reutilizadas com o novo plano de documentação do produto.
-
Observar modelos e guias de estilo - Se a documentação do produto for para um novo produto, certifique-se de que ela se mantenha dentro da voz e do estilo do setor ou, se a documentação pertencer a um produto existente, mantenha os guias de estilo e modelos atuais para garantir a continuidade da marca**.
-
Ferramentas de processo de documentação** - As ferramentas de documentação podem definir e otimizar o processo de documentação do produto, garantindo a continuidade do trabalho em equipe e uma melhor compreensão do processo de desenvolvimento de documentos.
3. Simplifique a documentação do produto como uma prática recomendada
Um estudo foi realizado em 2016 para determinar quantos usuários leem a documentação do produto. Os resultados foram reveladores, pois descobriram que apenas 25% dos usuários não leem a documentação do produto. A pesquisa constatou que a falta de leitura da documentação do produto pelos usuários finais se deve, em parte, ao seguinte:
Os usuários são impacientes - Com o advento das informações imediatas via Web, os usuários geralmente se tornam menos pacientes para descobrir respostas para seus problemas. Ler a documentação do produto on-line ou off-line pode ser trabalhoso devido à grande quantidade de informações necessárias para um determinado produto.
-
Síndrome do pulo** - Os usuários geralmente pulam a documentação necessária do produto e vão direto ao básico sobre como usá-lo. Os usuários aprendem e entendem como os produtos funcionam por meio da interação com o produto, em vez de ler instruções detalhadas. As instruções devem ser tão claras e informativas quanto possível.
-
Layout e estrutura confusos **- Os manuais geralmente são escritos em um formato difícil de entender e acompanhar. Muitos usuários acham a documentação do produto confusa ou irrelevante para sua pergunta, ficando frustrados e desestimulados a ler o manual. Muitas vezes, a empresa não realizou uma pesquisa de público detalhada e não entendeu corretamente o que o usuário precisava, ficando confuso demais para terminar a leitura.
4. Inclua capturas de tela e informações gráficas
Pense na documentação do produto como um roteiro que conta uma história sobre um produto. Conduza o cliente por um caminho facilmente identificado com capturas de tela ou outros gráficos e como cada gráfico diferente interage com o outro. Explique claramente o que o usuário está vendo ou quando um recurso é ativado, como ele reage ao produto e o que esperar em seguida. Certifique-se de que cada gráfico tenha um propósito e que o fluxo de trabalho do produto funcione entre si.
5. Use links cruzados para uma compreensão mais precisa dos tópicos.
Descobri que os links cruzados são inestimáveis ao ler a documentação do produto. Entender o que um recurso ou um processo de função faz ajuda imensamente a estabelecer links cruzados para um tópico associado. Além disso, ao fazer o cruzamento de pontos de dados associados, o quadro geral se torna mais aparente em relação a como o sistema interage e ao fluxo de trabalho.
6. Lembre-se do princípio KISS para a documentação do produto.
Lembre-se de usar o princípio KISS (Keep It Simple, Stupid) ao criar a documentação. Entretanto, é importante documentar completamente o processo, mas não a ponto de exagerar na documentação. Além disso, o usuário da documentação pode estar procurando determinadas informações sobre itens específicos, portanto, a adesão ao princípio KISS permite uma navegação e compreensão muito mais fáceis da documentação.
Por exemplo, notações simples podem ser suficientes para explicar uma função, talvez com uma referência (link cruzado) ao assunto principal. Mantenha os fatos claros e não exagerados, para que o usuário possa pesquisar facilmente as informações relevantes às suas necessidades. Talvez ele não esteja interessado em ler todos os aspectos do produto.
7. Acomode diferentes estilos de aprendizado
Cada pessoa tem um estilo diferente de aprendizado. Alguns preferem descrições detalhadas, enquanto outros podem preferir gráficos e representações visuais. No entanto, alguns usuários aprendem mais com o envolvimento prático do que com a leitura focada.
Certifique-se de incluir todos os estilos de aprendizado ao criar uma documentação eficaz e informativa sobre o produto. Por exemplo, a inserção de gráficos como capturas de tela, gráficos, texto estruturado ou links de vídeo ajuda a garantir que todos os estilos de aprendizagem compreendam a documentação do produto.
8. Personalize e estruture o conteúdo de integração
Personalize o produto a documentação com base na função do público. Crie diferentes versões da documentação com base nas funções do público-alvo ao integrar o conteúdo. Por exemplo, as perguntas de um administrador podem não ser relevantes para as perguntas de um usuário avançado sobre a documentação.
A documentação pode introduzir uma camada de personalização criando versões ligeiramente diferentes do documento, mais voltadas para a função do público-alvo. A modificação do conteúdo de integração com base na função do público-alvo dá à documentação um elemento de personalização.
9. Defina claramente os termos para públicos específicos
Dependendo do público-alvo, é uma boa prática explicar o significado de cada termo usado em toda a documentação. Você pode usar termos mais complexos com algum esclarecimento se o público for interno. No entanto, quando usuários externos acessam a documentação, não há como saber a experiência dos usuários.
A definição clara de termos exclusivos ou complexos estabelece comunicações muito melhores e mais eficientes para todas as partes interessadas internas e usuários externos.
10. Forneça um método para coletar feedback dos usuários
O feedback sobre a documentação fornece informações importantes sobre a eficácia do documento. Forneça um link ou um simples botão com "Curtir/Descurtir" para coletar informações valiosas sobre a qualidade da documentação. Ao coletar feedback do usuário, a documentação pode ser refinada e aprimorada.
11 Evite documentação com uma estrutura plana
Ao criar a documentação do produto, certifique-se de que ela não seja escrita como uma "estrutura plana". A leitura de um documento cheio de texto plano é trabalhosa e também pode se tornar entediante. Além disso, o interesse do leitor na documentação será maior se as informações forem relevantes para o tópico discutido e se o leitor puder consumi-las rapidamente.
Quebre o texto plano e contínuo destacando as informações selecionadas ou integrando vídeos, imagens, links e outros métodos para proporcionar uma experiência de usuário melhor. Além disso, ao fornecer o conteúdo do documento em pedaços pequenos, o leitor terá uma experiência mais agradável e ficará menos relutante em ler a documentação.
12. Crie uma documentação que seja compatível com SEO
Uma prática recomendada de documentação de produtos on-line é garantir que ela seja escrita em um estilo documentação amigável para SEO. Garantir que a documentação seja escrita para maximizar os resultados de pesquisa na Internet para sua documentação. Os clientes podem precisar pesquisar a documentação e, quando não têm o link explícito para o site de hospedagem, ao inserir os termos de pesquisa, as respostas são mais rápidas e concisas quando são compatíveis com SEO.
13. Mantenha a documentação do produto atualizada
A manutenção da documentação do produto é crucial, principalmente se for acessada on-line. Muitas vezes, os requisitos de um produto mudam e a documentação on-line deve refletir todas as novas alterações ou atualizações. Portanto, a documentação do usuário precisa ser atualizada e atualizada para quaisquer atualizações recentes e garantir que o cliente seja notificado e esteja ciente das alterações na documentação do produto.
14. Entenda que os usuários podem não ler a documentação do produto
Um estudo de 2014 descobriu que os usuários não liam completamente](https://academic.oup.com/iwc/article-abstract/28/1/27/2363584?redirectedFrom=fulltext&login=false) toda a documentação do produto. Os principais motivos para não ler a documentação foram:
-
A documentação do produto era excessivamente complexa
-
A documentação não abordava diretamente suas perguntas
-
Os usuários não usavam muitos recursos do produto por não lerem a documentação.
-
Em vez de ler a documentação, muitos usuários preferiam o aprendizado "prático".
15. Gerenciar conteúdo dinâmico e estático
A documentação do produto evolui continuamente com atualizações, novos recursos, conteúdo corrigido, alertas de manutenção atualizados e outros itens. Essa atualização é considerada um documento vivo, que respira e evolui continuamente de acordo com os requisitos do produto.
O conteúdo estático fornece ao usuário dados que não mudam ao longo da vida útil do produto. A ideia do conteúdo estático é fornecer referências aos usuários, especialmente aos novos usuários, com informações que permanecem estáticas durante o ciclo de vida do produto. O conteúdo estático é essencial para uma documentação rica, mas geralmente fica em segundo plano em relação à documentação dinâmica.
A manutenção do conjunto de documentação é mais fácil quando o conteúdo é classificado como dinâmico ou estático. A documentação do ciclo de vida do produto pode ser implementada e validada mais facilmente quando a documentação é categorizada como dinâmica ou estática. Pode haver pequenas alterações na documentação para atualizações de novos recursos (estática) ou atualizações detalhadas do produto (dinâmica).
16. Práticas recomendadas para a disponibilidade da documentação do produto
Embora os usuários não necessariamente leiam muita documentação do produto, quando precisam dela, eles a querem imediatamente. O método tradicional de entrega da documentação era ter um manual impresso que acompanhava o produto. No entanto, no mundo digital e on-line de hoje, a documentação é frequentemente fornecida pela Web.
Independentemente de como a documentação do produto está sendo entregue, é essencial ter pontos de acesso prontamente disponíveis. Portanto, os métodos predominantes de fornecimento de documentação atualmente são:
-
Documentação off-line - Muitos produtos são embalados com manuais impressos ou folhas de atalho de "início rápido". Esses documentos geralmente são "únicos" e não são facilmente distribuídos. Entretanto, muitos manuais são fornecidos opcionalmente em um formato PDF encapsulado, promovendo a portabilidade ou a opção de impressão sob demanda.
-
Documentação on-line**- Toda vez que você pesquisa no Google uma resposta para um problema, provavelmente está acessando um trecho da documentação on-line. O advento da Web substituiu a impressão de manuais ou materiais de documentação de produtos para os usuários finais. Alguns dos benefícios da documentação on-line são:
-
Teletrabalho - Uma coisa que a pandemia nos ensinou é que trabalhar em casa pode ser tão produtivo quanto no escritório, especialmente quando nossas perguntas são respondidas com documentação on-line.
-
Colaboração - Com um portal de documentação on-line prontamente acessível, os membros da equipe podem compartilhar informações em tempo real e criar um trabalho em equipe, o que muitas vezes é impossível no escritório.
-
Compatível com dispositivos móveis - O advento dos dispositivos móveis, como iPads e smartphones, tem lentamente suplantado os PCs nas interações cotidianas. Você pode acessar facilmente a documentação on-line com um smartphone, e qualquer problema incômodo com o produto pode ser prontamente pesquisado, mesmo em seu café favorito durante o almoço.