Este falso passe ensinou-me que preciso de olhar para o nosso produto através do prisma do cliente. Depois o proverbial interruptor de luz clicou "on". Se eu entregar um produto que trate os pontos de dor do cliente, então apoiá-lo com documentação profissional do produto, teremos um vencedor.
E também descobri que criar documentação de produtos profissional, esteticamente agradável e de fácil leitura não era uma tarefa fácil. Mas quando feita correctamente, a documentação do produto pode tornar os clientes satisfeitos e, em última análise, aumentar as receitas.
Quais são as melhores práticas para a criação de documentação profissional de produtos?
Estas melhores práticas criam uma documentação de produto esteticamente agradável, informativa e fácil de usar. Seguir estas directrizes irá ajudá-lo a entregar documentação de produto que pode tornar um bom cliente num grande cliente. E os grandes clientes acabam por ajudar as empresas a aumentar as receitas, sendo a documentação do produto uma componente vital da experiência do cliente.
1. Compreenda o seu público-alvo e dê-lhes o que eles querem
É essencial saber quais são as expectativas do seu público. Por exemplo, a documentação do produto destina-se a Administradores ou Utilizadores Finais? O âmbito do seu público-alvo pode exigir a redacção técnica para Administradores ou em termos e instruções claramente definidos para o Utilizador Final.
Uma melhor prática para criar documentação profissional de produtos é compreender as expectativas dos clientes a nível de Administrador ou Utilizador Final. Alguns dos métodos para recolher informações de identificação do público são:
-
Questionários e Inquéritos
-
Feedback do público percebido
-
brainstorming da empresa
-
Feedback sobre opiniões populares dos clientes
-
Debates em mesa redonda com clientes
2. Criar um plano de documentação como uma melhor prática
A redacção de um plano de documentação pode ajudar a visualizar quaisquer potenciais estrangulamentos durante a implementação do projecto. Criar documentação do produto pode ser um desafio, e uma boa prática é criar um plano de documentação para ajudar a prever problemas que possam surgir durante o processo de documentação.
Entre as vantagens de criar um plano de documentação estão as seguintes:
- Auditoria de qualquer documentação existente a informação aplicável de Salvagem** que pode ser reutilizada com o novo plano de documentação do produto.
Observe modelos e guias de estilo - Se a documentação do produto for para um novo produto, certifique-se de que se mantém dentro da voz e estilo da indústria, ou se a documentação pertencer a um produto existente, mantenha os actuais guias de estilo e modelos para seguir a continuidade da marca.
*Ferramentas para o processo documental - As ferramentas de documentação podem definir e racionalizar o processo de documentação do produto, assegurando ao mesmo tempo a continuidade do trabalho de equipa e uma melhor compreensão do processo de desenvolvimento de documentos.
3. Simplificar a documentação do produto como uma melhor prática
Foi realizado um estudo em 2016 para determinar quantos utilizadores leram a documentação do produto. Os resultados foram reveladores, pois descobriram apenas 25% dos utilizadores não lêem a documentação do produto. O inquérito descobriu que a falta de utilizadores finais que não lêem a documentação do produto deve-se em parte ao seguinte:
-
Os utilizadores são impacientes - Com o advento da informação imediata através da web, os utilizadores tornam-se tipicamente menos pacientes na descoberta de respostas para os seus problemas. A leitura de documentação de produtos online ou offline pode ser trabalhosa devido à abundante quantidade de informação necessária para um determinado produto.
-
Síndrome de "skip-ahead " - Os utilizadores saltam frequentemente a documentação necessária do produto directamente para o básico de como utilizar o produto. Os utilizadores aprendem e compreendem como os produtos funcionam através da interacção com o produto, em vez de lerem instruções detalhadas. As instruções devem ser tão claras e informativas quanto possível.
*- A disposição e estrutura confusa - Os manuais são frequentemente escritos num formato que é difícil de compreender e seguir. Muitos utilizadores acham a documentação do produto confusa ou irrelevante para a sua pergunta, ficando frustrados e desencorajados de ler o manual. Muitas vezes, a empresa não conduziu uma pesquisa detalhada do público e não compreendeu correctamente o que o utilizador precisava, e ficou demasiado confusa para terminar a leitura.
4. Incluir capturas de ecrã e informação gráfica
Pense na documentação do produto como um mapa rodoviário que conta uma história sobre um produto. Conduza o cliente por um caminho facilmente identificado com capturas de ecrã ou outros gráficos e como cada gráfico diferente interage com o outro. Explique claramente para o que o utilizador está a olhar ou quando uma característica é activada, como reage ao produto, e o que esperar a seguir. Certifique-se de que cada gráfico é propositado e que o fluxo de trabalho do produto funciona um com o outro.
5. Utilizar ligações cruzadas para uma compreensão mais precisa dos tópicos.
Descobri ligações cruzadas que são inestimáveis na leitura da documentação do produto Compreender o que uma característica ou processo de função faz, ajuda imensamente a fazer a ligação cruzada com um tópico associado. Além disso, ao cruzar pontos de dados associados, o quadro geral torna-se mais aparente relativamente à forma como o sistema interage e fluxo de trabalho.
6. Lembre-se do princípio KISS para a documentação do produto.
Lembre-se de utilizar o princípio KISS (Keep It Simple, Stupid) quando criar documentação. No entanto, é importante documentar minuciosamente o processo, mas não ao ponto de documentação exagerada. Além disso, o utilizador da documentação pode estar à procura de certas informações sobre itens específicos, pelo que 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 (cross-link) ao assunto principal. Manter os factos limpos e não exagerados, para que o utilizador possa facilmente procurar informação relevante para as suas necessidades. Podem não estar interessados na leitura de todos os aspectos do produto.
7. Acomodar diferentes estilos de aprendizagem
Cada pessoa tem um estilo de aprendizagem diferente. Alguns preferem descrições em profundidade, enquanto outros podem preferir gráficos e representações visuais. No entanto, alguns utilizadores aprendem mais através do envolvimento prático do que da leitura focalizada.
Assegurar a inclusão de todos os estilos de aprendizagem ao criar documentação eficaz e informativa do produto. Por exemplo, a inserção de gráficos como capturas de ecrã, gráficos, texto estruturado, ou ligações vídeo ajuda a garantir que todos os estilos de aprendizagem compreendem a documentação do produto.
8. Personalizar e estruturar o conteúdo a bordo
Personalizar o produto documentação baseada no papel do público. Criar diferentes versões da documentação com base nos papéis da audiência pretendida ao embarcar no conteúdo. Por exemplo, as perguntas de um administrador podem não ser relevantes para as perguntas de um utilizador com poder sobre a documentação.
A documentação pode introduzir uma camada de personalização, criando versões ligeiramente diferentes do documento mais direccionadas para o papel do público pretendido. A modificação do conteúdo de bordo com base no papel do público dá à documentação um elemento de personalização.
9. Definir claramente os termos para audiências específicas
Dependendo do público pretendido, é uma boa prática explicar o significado de cada termo utilizado ao longo da documentação. Pode-se utilizar termos mais complexos com algum esclarecimento se o público for interno. No entanto, quando utilizadores externos acedem à documentação, não há forma de conhecer a perícia dos utilizadores.
A definição clara de termos únicos ou complexos estabelece comunicações muito melhores e mais eficientes para todos os intervenientes internos e utilizadores externos.
10. Fornecer um método para recolher o feedback do utilizador
O feedback da documentação fornece informação poderosa sobre a eficácia do documento. Fornece um link ou um simples botão com "Like/Dislike" para recolher informação valiosa sobre a qualidade da documentação. Ao recolher o feedback do utilizador, a documentação pode ser refinada e melhorada.
11 Evitar documentação com uma estrutura plana
Ao criar a documentação do produto, certifique-se de que a documentação não está escrita como uma "estrutura plana". A leitura de um documento cheio de texto plano é trabalhosa, e pode também tornar-se enfadonha. Além disso, o interesse do leitor na documentação será aumentado se a informação for relevante para o tópico discutido, e um leitor pode rapidamente consumi-la.
Quebrar o texto contínuo e plano destacando a informação seleccionada ou integrando vídeos, imagens, ligações, e outros métodos para fornecer um melhor UX. Além disso, ao entregar o conteúdo do documento em pedaços de "tamanho mordida", o leitor terá uma experiência mais agradável e estará menos relutante em ler a documentação.
12. Criar documentação que seja compatível com SEO
Uma melhor prática de documentação de produtos em linha é certificar-se de que é escrita num estilo documentação SEO-friendly. Assegurar que a documentação é escrita para maximizar os resultados de pesquisa em toda a Internet para a sua documentação. Os clientes podem precisar de procurar a sua documentação, e quando não têm a ligação explícita ao site de alojamento, introduzindo termos de pesquisa, as respostas são mais rápidas e mais concisas quando amigáveis em termos de SEO.
13. Manter a documentação do produto actualizada
A manutenção da documentação do produto é crucial, principalmente se se tiver acesso online. Muitas vezes, os requisitos de uma alteração de produto e a documentação em linha devem reflectir quaisquer novas alterações ou actualizações. Por conseguinte, a documentação do utilizador precisa de ser actualizada e actualizada para quaisquer actualizações recentes e garantir que o cliente é notificado e está ciente das alterações na documentação do produto.
14. Compreender que os utilizadores não podem ler a documentação do produto
A estudo 2014 descobriu que os utilizadores não leram completamente toda a documentação do produto. As principais razões para a não leitura da documentação foram:
-
A documentação do produto era excessivamente complexa
-
A documentação não abordou directamente as suas questões
-
Os utilizadores não utilizaram muitas características do produto devido a não terem lido a documentação
-
Em vez de ler a documentação, muitos utilizadores preferiram a aprendizagem "prática".
15. Gerir tanto o conteúdo dinâmico como estático
A documentação do produto evolui continuamente com actualizações, novas funcionalidades, conteúdo corrigido, alertas de manutenção actualizados, e outros itens. Esta actualização é considerada um documento vivo e respirável que está em contínua evolução para os requisitos do produto.
O conteúdo estático fornece ao utilizador dados que não se alteram ao longo da vida do produto. A ideia do conteúdo estático é dar referências aos utilizadores, especialmente aos novos utilizadores, informação que permanece estática ao longo do ciclo de vida do produto. O conteúdo estático é vital para uma documentação rica mas, tipicamente, assume o lugar de trás para a 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 é classificada como dinâmica ou estática. Pode haver pequenas alterações na documentação para actualizações de novas características (estáticas) ou actualizações detalhadas do produto (dinâmicas).
16. Melhores práticas para a disponibilidade de documentação do produto
Embora os utilizadores possam não ler necessariamente muita documentação do produto, quando precisam dela, querem-na imediatamente. O método tradicional de entrega de documentação era ter um manual impresso que viajava com o produto. No entanto, no mundo digital actual, a documentação é muitas vezes entregue através da web.
Independentemente da forma como a documentação do produto está a ser entregue, é essencial ter pontos de acesso prontamente disponíveis. Por conseguinte, os métodos predominantes de fornecimento de documentação são hoje em dia:
- Offline documentation - Muitos produtos são embalados com manuais impressos ou folhas de atalhos "Quick Start". Estes documentos são normalmente "one-offs" e não são facilmente distribuídos. Contudo, muitos manuais são opcionalmente fornecidos num formato PDF encapsulado, promovendo a portabilidade ou a opção de imprimir a pedido.
Online documentation- Cada vez que procura no Google uma resposta para um problema, provavelmente está a agarrar um fragmento de documentação online. O advento da web suplantou a impressão de manuais ou materiais de documentação de produtos para os utilizadores finais. Algumas das vantagens da documentação em linha são:
-
Teletrabalho - Uma coisa que a pandemia nos ensinou é que trabalhar a partir de casa pode ser produtivo como o escritório, especialmente quando as nossas perguntas são respondidas com documentação em linha.
-
Colaboração - Com um portal de documentação em linha facilmente acessível, os membros da equipa podem partilhar informações e criar trabalho de equipa, o que muitas vezes é impossível no escritório.
-
Amigo dos telemóveis - O advento de dispositivos móveis como os iPads e smartphones suplantou lentamente os PCs para interacções do dia-a-dia. Pode aceder facilmente à documentação online com um smartphone, e quaisquer questões incómodas sobre produtos podem ser facilmente pesquisadas, mesmo no seu café favorito durante o almoço.