Muitas empresas de tecnologia SaaS enfrentam dificuldades no processo de desenvolvimento e distribuição de documentação de produto (manuais de utilizador, guias e/ou tutoriais) para os seus consumidores.
Frequentemente, isto acontece devido à falta de conhecimento ou de um processo adequado para o tratamento e produção de manuais, ou mesmo sobre quem é responsável por eles.
Enquanto existirem ferramentas e software neste mundo, precisaremos de comunicação eficaz para transmitir aos outros a utilização, desenvolvimento, funcionamento e arquitetura destes produtos. Se questionas o porquê, a resposta é simples: as competências de comunicação técnica são fundamentais para recolher informação e permitir que o público compreenda melhor o produto ou tecnologia.
Enquanto a comunicação no mundo real é feita através da fala, linguagem corporal e expressões emocionais, no mundo virtual a comunicação técnica acontece através da documentação técnica do produto!
O único objetivo da documentação técnica do produto é facilitar a compreensão do utilizador sobre a dinâmica de funcionamento e a arquitetura de um produto ou tecnologia. É como um "manual de utilização" para os teus novos colaboradores, utilizadores/clientes e qualquer pessoa que precise de conhecer os métodos de funcionamento, uma descrição completa das peças fundamentais de um produto!
É dever do gestor de produto assumir a responsabilidade de desenvolver uma equipa para criar, gerir, publicar e manter documentação de produto polida.
Tenho a certeza que todos os gestores de produto já disseram ou ouviram o seguinte no seu departamento: "A documentação do produto faz parte das obrigações do Product Owner"; "Cada equipa de desenvolvimento deve documentar as suas próprias aplicações"; "a funcionalidade foi implementada, o manual foi atualizado?" ou, ainda pior, "há um erro na documentação técnica."
Claramente, a documentação técnica do produto pode ser um pouco confusa, apesar de parecer simples! Enquanto as pessoas tentam resolver ou discutir as frases no parágrafo anterior, os manuais e tutoriais deterioram-se, o que é prejudicial para a imagem do teu "produto/empresa".
Para ajudar quem estiver a enfrentar problemas semelhantes, aqui estão alguns procedimentos a implementar para otimizar a documentação do teu produto.
Qual é o objetivo da documentação de produto?¶
Quando falamos de documentação de produto para um produto ou serviço tecnológico, referimo-nos à informação que o descreve e aos dados que lhe dizem respeito.
A documentação técnica, ou documentação de produto, serve para ajudar o teu público e clientes a utilizarem, lerem, compreenderem e aproveitarem o teu produto. A maioria das documentações de produto são produzidas em diversas áreas, incluindo engenharia, medicina, tecnologia da informação e marketing.
Uma excelente documentação técnica de produto ajuda o teu público a navegar pelo produto e permite-lhes utilizá-lo sem complicações.
Outra consideração importante é que a documentação técnica é fundamental para o apoio ao cliente e contribui significativamente para a marca e confiança da tua empresa. Quando mais precisam, os utilizadores procuram documentação técnica. O público usa o teu produto para aprender sobre os processos e lidar com problemas.
Isto significa que ter uma documentação de produto completa e abrangente, com capacidades dinâmicas de pesquisa, é muito importante.
Quais são os diferentes tipos de documentação de produto¶
Esta secção permite-te ver que tipo de documentação de produto precisas para os teus clientes.
Existem muitos tipos diferentes de documentação de produto que atendem às necessidades de diferentes casos de uso e necessidades dos utilizadores:
Documentação de utilizador do produto: Consiste em manuais de utilizador, guias práticos, tutoriais, FAQs, notas de lançamento, manuais de formação e procedimentos operacionais.
Documentação corporativa: Estudos mostram que mais de 8 em cada 10 empresas, de 1000 empresas inquiridas, utilizam manuais formais de políticas e procedimentos.
Existem muitos outros tipos de documentação corporativa que incluem documentação referente às políticas e procedimentos das empresas, conforme indicado na pesquisa acima, manuais de instruções, práticas técnicas, documentação comportamental e ética. Além de documentação jurídica que pode ser protegida por palavra-passe. Também estruturas empresariais, boas práticas, procedimentos e manuais de manutenção.
Documentação para Programadores: este tipo de documentação fornece instruções para o desenvolvimento de produtos de software, especificações funcionais, especificações técnicas, documentação e ferramentas para auxiliar o fluxo de trabalho do programador.
Agora que compreendemos melhor os diferentes tipos de documentação técnica e de produto, vamos discutir como começar um processo sólido de desenvolvimento de documentação de produto.
Encontrar um responsável pelo desenvolvimento da documentação de produto¶
Um problema muito comum é determinar quem deve ser responsável pela documentação do produto, não apenas como alguém que a atualiza, mas como alguém que é responsável pela qualidade e sucesso do produto.
Enquanto algumas empresas acreditam que cada product owner e/ou gestor de produto é responsável pela documentação do produto, outros departamentos como desenvolvimento e suporte também podem ser encarregados da responsabilidade de manter manuais de utilizador, guias e todos os aspetos da documentação do produto atualizados e eficazes.
O desenvolvimento da documentação de produto tem muitas peças móveis, mas aqui vamos destacar duas delas:
-
Quem compreende como o produto funciona em todos os níveis (isto inclui as equipas de desenvolvimento e especificações do produto).
-
Aqueles que recebem feedback dos clientes que analisam a documentação do produto e ouvem as suas dificuldades, feedback e preocupações sobre a compreensão da documentação do produto em questão.
A primeira parte ajuda-nos a criar a documentação do produto com o conhecimento disponível, que é enviada ao cliente, que por sua vez dá feedback e inicia o segundo processo, que ajuda a otimizar a documentação.
Por vezes, estes dois pontos não estão perfeitamente alinhados, o que cria situações em que a documentação do produto nunca recebe a atenção necessária.
Uma abordagem é designar uma pessoa para ser responsável pelo "desempenho" da documentação do produto, manuais e guias do utilizador. Considera uma ordem de compra que tem "Documentação do Produto" como seu produto. Esta pessoa é responsável por percorrer todas as equipas da empresa, esquematizar como cada Produto gera os seus guias e identificar os desafios associados a esse processo.
A intenção não é que este product owner e gestor de produto seja totalmente responsável pela geração e modificação de manuais, mas sim ajudar as pessoas dentro de cada equipa na gestão de documentos.
Esta pessoa deve estudar como os utilizadores interagem com os documentos, oferecer formas de tornar as atualizações mais fluidas e recolher feedback para determinar como melhorar cada documentação de produto com o seu público-alvo.
Ter alguém responsável por todos os aspetos da documentação do produto, gerindo o fluxo de trabalho e os diferentes departamentos necessários para completar esta documentação, aumentará a produtividade dentro da empresa, estabelecerá consciência e educará os clientes com portais de conhecimento sobre o produto, além de simplificar a compreensão geral do produto.
Olhar para a documentação do produto como um produto em si¶
Os produtos existem para oferecer um grau de valor que atende ou excede as expectativas do cliente. Com base em estatísticas geradas pela D2WorldWide, 73,7% das pessoas consideram a documentação mais útil do que vídeos, embalagens ou vendedores quando procuram informações sobre produtos que estão a considerar comprar.
Considera os fatores que contribuem para a atratividade de um produto. Existem vários fatores que podem afetar a atratividade de um produto, mas para este artigo, vamos concentrar-nos em três: excedem as expectativas em termos de valor; a sua utilização gera satisfação; e são competitivos.
Além disso, os mesmos conceitos aplicam-se a uma boa documentação de produto online. Documentos de produto que vão "além do valor esperado" ilustram não apenas como usar o item específico, mas também oferecem soluções que o cliente desconhece ou não acredita serem possíveis. É sempre necessário ver como outras empresas iniciam a sua documentação de produto para aprender com os seus sucessos e erros.
Não faz sentido ter uma empresa que desenvolve software único e de alta qualidade à frente da concorrência se os programadores e clientes que integram os seus documentos técnicos de produto não conseguem compreendê-los.
Considera que a pessoa que lê a documentação do produto pode não estar familiarizada com a gama de soluções possíveis oferecidas pelo produto ou com o mercado (como é comum com produtos SaaS técnicos), e por isso deve ser "educada" sobre essas soluções e várias opções relacionadas com o produto.
Documentos de produto cuja "usabilidade gera satisfação" seguem um padrão lógico de leitura adequado ao seu público-alvo. Não serve de nada ter o manual mais completo do mundo se for um PDF de 500 páginas ou não incluir um exemplo de código e não for criado dinamicamente com capacidades de pesquisa e outras funções. Recolhe feedback dos utilizadores do teu documento de produto e da tua equipa de suporte. Eles determinarão as principais áreas de stress ligadas aos dados reportados.
Documentações de produto competitivas são aquelas que são continuamente atualizadas usando as técnicas mais eficazes de troca de informações. Têm recursos incríveis como capacidades de pesquisa integradas, traduções, diferentes versões, imagens incorporadas, vídeos e muito mais!
Mesmo que o teu guia de integração seja o melhor escrito de todas as empresas de tecnologia, faltará a atração sem um vídeo adicionado, imagens e códigos que possam ser copiados e colados para facilitar o uso pelos teus clientes tecnicamente experientes que compram os teus produtos SaaS técnicos.
É sempre necessário ver como outras empresas iniciam os seus documentos para aprender com os seus sucessos e erros.
Não faz sentido ter uma empresa que desenvolve software único e de alta qualidade à frente da concorrência se os programadores e clientes que integram os teus documentos não conseguem compreendê-los na sua totalidade.
Feedback da documentação do produto
Uma documentação técnica de produto eficaz melhora a experiência do utilizador final, aperfeiçoando o processo de compreensão dos produtos e diagnosticando problemas com soluções escritas prontamente disponíveis. Quando os clientes confiam e entendem como usar os teus produtos, podem voltar a ti no futuro quando surgir a necessidade.
Nova pesquisa realizada pela SDL demonstra que o papel da documentação nos mercados globais está a aumentar. A pesquisa mostra que cerca de 53% dos compradores fazem compras usando literatura técnica antes mesmo de experimentar o produto. Além disso, outra estatística compilada desta pesquisa mostra que 94% dos compradores consideram útil ter informações sobre o produto num único local. Por causa disso, cada empresa dá hoje igual ênfase à documentação do produto e ao desenvolvimento ou teste do produto.
Mesmo que a documentação tenha um proprietário designado que gere a equipa de documentação, que tenha criado documentação de produto que foi revista e avaliada para melhorar a usabilidade e tenha sido devidamente atualizada, continuas a ter dificuldades em fazer com que os teus utilizadores e consumidores compreendam os teus produtos técnicos. Isto pode surgir como resultado da incapacidade dos utilizadores/leitores de compreender como os teus documentos estão a ser lidos ou as perguntas que realmente estão a fazer. Isto torna um dos aspetos mais desafiantes da composição de documentos colocar-se no lugar do leitor. Afinal, quem produz a documentação do produto deve ter um conhecimento sólido do produto.
Esta experiência pode fazer com que o escritor ignore coisas que não são tão óbvias para o utilizador médio. Normalmente, isto ocorre quando algo que é evidente para as pessoas que criam o produto não é tão claro para aqueles que o compram e utilizam.
Isto pode acontecer de várias formas:
Estrutura ou forma de escrita: Embora isto possa parecer subjetivo, mesmo a maneira como um manual é escrito pode criar confusão. É fundamental identificar o tipo de leitor que lê a documentação; caso contrário, podem surgir frases como "Os programadores preferem exemplos a texto descritivo" ou "A nossa documentação não é clara apesar da presença de exemplos e elementos visuais".
Organização dos tópicos nos manuais: Ocasionalmente, empresas que operam no mesmo mercado desenvolvem um formato padronizado de documentação. Se os guias da tua empresa não o seguirem, o leitor pode ter uma sensação de estranheza.
Uso excessivo de termos implícitos: Quando aplicadas a um manual, as abreviações podem fazer pouco sentido, mesmo que as frases não sejam acrónimos. É difícil perceber, mas algumas palavras, como "status", "id", "credenciais", contêm um significado implícito disfarçado de explícito. Utiliza designações específicas, como "UserID", em vez de "UID".
Tradução válida: a tradução é uma parte enorme do alcance global. Muitas vezes, as empresas criam manuais de utilizador e documentação de produto mal traduzidos que não correspondem à cultura de certas nações ou simplesmente as palavras não se traduzem da mesma forma que em inglês para esse país em particular. Compreender estas nuances subtis pode transformar a documentação do produto de informação ilegível em documentação totalmente abrangente e bem traduzida.
Para evitar tais situações, o objetivo é desenvolver uma solução que recolha e analise o feedback dos utilizadores e os padrões de navegação.
Ferramentas de feedback como o Vocally, uma funcionalidade do Docsie, são uma ótima forma de receber e avaliar padrões de navegação e analisar como os teus clientes estão a ver a documentação do teu produto. Aprende as 7 regras de ouro para recolher feedback aqui.
Esta informação é crucial para atualizar e otimizar os teus guias de utilizador, manuais e documentação de produto, criando uma experiência mais fluida para os teus clientes aprenderem sobre os teus produtos. Nada é mais frustrante do que introduzir um novo produto e descobrir um aumento nos pedidos de Suporte devido a instruções inadequadas no manual.
Como escrever documentação de produto abrangente¶
Uma documentação de produto de qualidade é cativante, útil e poderosa. Diria que uma documentação competente é um componente necessário de uma boa gestão de produto. Tanto quanto os gestores de produto participam no desenvolvimento de produtos, uma parte significativa do sucesso é criar documentação de produto surpreendente e polida que os nossos clientes possam compreender e usar para aprofundar o seu conhecimento sobre os nossos produtos.
O que se passa com a maioria da documentação de produto?¶
Muitos gestores de produto são avessos a redigir documentos de produto. A documentação de produto com que estão familiarizados pode não ter impacto junto dos seus clientes, a menos que seja dada mais atenção para torná-la atraente, fácil de ler e relacionável.
No entanto, muitas vezes as empresas não têm o cuidado necessário para criar e elaborar uma documentação de produto incrível. Uma documentação de produto fraca é escrita apenas por escrever. Emprega frases expansivas cheias de pensamentos vagamente aceitáveis e um layout pobre para desencorajar os leitores de interagir com o material. Uma documentação de produto pobre é criada para proteger o autor de críticas e é uma completa perda de tempo para todos. E os seus clientes não gostam de a ler por este motivo também.
Como podemos corrigir isto e escrever melhor documentação de produto que os nossos clientes gostarão de ler?¶
Uma excelente documentação de produto é escrita com a intenção de ser lida. É sucinta. Uma boa documentação de produto é bem formatada e pode ser lida e compreendida por todos na empresa ou pelos clientes em três minutos. Evita jargão e fornece ou refere-se a uma perspetiva de nível de negócio. Uma excelente documentação de produto dedica tempo a delinear casos de uso específicos que os clientes podem entender e aplicar para melhorar a utilização do produto. Envolve o leitor e chama a atenção para problemas subjacentes com soluções bem elaboradas.
O poder de uma documentação de produto bem escrita¶
Onde existem pequenas, médias ou grandes empresas, documentos técnicos de produtos bem formatados podem poupar muito tempo e ajudar os funcionários a trabalhar de forma mais produtiva. Isto é geralmente verdade para a maioria das empresas baseadas em produtos, que gastam uma grande percentagem dos seus orçamentos na contratação de redatores técnicos e na redação de documentação técnica de produto.
Se a tua empresa emprega mais de duas pessoas para criar documentação de produto, estabelecer uma cultura de boa documentação vale completamente a pena. Existem muitas razões pelas quais quererias que a tua equipa criasse, gerisse e publicasse documentação de produto bem elaborada, mas na secção abaixo vamos abordar como uma documentação de produto eficaz é uma abordagem de baixo custo para melhorar a experiência do cliente.
Documentação de produto eficaz é uma abordagem de baixo custo para melhorar a experiência do cliente¶
Uma boa experiência do cliente é a base para manter e reter clientes fiéis. A maioria dos gestores de projeto são otimistas — obtêm um conceito, entusiasmam-se e depois executam. Embora a paixão seja admirável e a execução pareça produtiva, ter um plano de jogo antes de executar a documentação adequada do produto é vital.
Os primeiros passos após o brainstorming de um plano de jogo é iniciar um ciclo de design e estruturar o conteúdo da documentação do produto de tal forma que seja progressivamente fácil para os clientes lerem.
Além disso, obter feedback dos clientes sobre a documentação atual é um passo vital necessário para reestruturar os documentos de acordo com as necessidades dos clientes. Desta forma, os gestores de projeto podem criar, gerir, manter, publicar e otimizar a sua documentação com perceção e automação. Esta não é uma tarefa simples e insignificante, e ter ferramentas incríveis como o Docsie, que automatiza muitos dos processos para tornar a documentação do produto eficaz, é essencial para o sucesso.
Documentação técnica atraente, envolvente e navegável ajuda os consumidores a aprender o produto em menos tempo, o que aumenta a probabilidade de configurarem o produto corretamente e usarem-no corretamente.
Todas estas estratégias para criar documentação de produto bem polida levarão essencialmente a produtos melhor classificados, avaliações mais favoráveis e mais vendas estão todos ligados entre si; portanto, é óbvio que o aumento das vendas como resultado.
Como criar documentação de produto bem elaborada¶
Como produzir documentação eficaz e fomentar uma cultura onde isso é o padrão? Escrever documentação eficaz é desafiante, mas existem muitas boas funcionalidades no Docsie que podem ajudar a acelerar este processo de criação de portais de documentação de produto bem elaborados e dinâmicos. Segue-se um resumo de alto nível de como abordamos o problema.
Vamos começar:¶
As limitações de página garantem legibilidade. Escrever um documento decente não deve ser difícil de ler e processar mentalmente. Frases prolongadas e divagantes são frequentemente indicativas de falta de clareza. Se a comunicação não puder ser adequadamente resumida numa única página, é um sinal de que o gestor do produto provavelmente deve voltar atrás e decompor ainda mais a situação.
A formatação melhora a qualidade. Uma documentação de produto mal estruturada aumenta a probabilidade de o escritor improvisar. Cria um modelo com secções bem formatadas, tabelas e cabeçalhos de documento. É um investimento único com alto potencial de dividendos.
Os modelos ajudam-te a poupar tempo. É muito mais fácil eliminar uma secção de um modelo do que lembrar-se de adicionar uma. Não é condescendente; é eficaz e poupa tempo. Secções simples que lembram o escritor de começar com o contexto geral e ser específico sobre medições ou suposições perigosas permitem uma escrita mais precisa e hierarquia de decisão.
Comentar e atribuir tarefas. Não há maneira mais certa de desmotivar a tua equipa a produzir documentação de alta qualidade do que não comentar sobre ela. Os comentários não precisam de ser muito inteligentes; antes, devem indicar envolvimento e servir como modelo. Embora seja ideal fornecer feedback digitalmente para que outros na empresa possam beneficiar de forma assíncrona da conversa, uma funcionalidade simples no Docsie que te permite comentar e colaborar com a tua equipa funciona muito bem para a equipa de documentação do produto!
Consulta este blog para saber mais sobre como o Docsie ajuda na Colaboração da Documentação de Produto
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
Os tipos de documento devem ser escaláveis para atender às necessidades da tua empresa. À medida que mais partes interessadas se envolvem no processo de desenvolvimento do produto, a comunicação deve ser dividida em vários documentos (particularmente se o critério de "concisão" de uma página for mantido). O Docsie oferece uma solução útil e sustentável para equipas de documentação de produto em crescimento.
Usa o Docsie como forma de acelerar a criação de documentação de produto incrível¶
O Docsie é uma plataforma muito útil que te ajuda em todos os aspetos da criação de documentação de produto e portais de conhecimento. Tem muitas funcionalidades incorporadas que tornam a criação, publicação, manutenção e gestão de projetos de documentação de produto realmente simples e divertida! Aqui estão apenas algumas das muitas funcionalidades do Docsie que podem ajudar-te a atingir estes objetivos:
Capacidade de editar: O Docsie permite que todos os nossos utilizadores editem a documentação do produto após a publicação, criando uma versão alternativa que não ficará ativa até ser ativada. Isto é fantástico porque as equipas de gestão de produto podem trabalhar na edição e alteração da documentação do produto e depois torná-la ativa quando estiverem prontas, sem terem de lidar com HTML e CSS. A documentação será automaticamente apresentada com uma simples mudança quando estiverem prontos.
Capacidade de pesquisa: se tiveres muita documentação de produto ou muitas funcionalidades, o plugin de pesquisa do Docsie adiciona um bónus útil que permite que os teus clientes pesquisem rapidamente e facilmente pela tua documentação para encontrar a informação de que precisam, acelerando o processo de visualização e absorção de informações da tua documentação de produto.
Capacidade de ligação: O Docsie torna a tua documentação de produto amigável para SEO. Podes criar links para determinadas páginas no website da tua empresa ou simplesmente escrever palavras-chave baseadas nos teus produtos que serão pesquisáveis online e atrairão novos clientes à procura do mesmo produto que tens disponível.
Capacidade de ter diferentes traduções: O tradutor avançado do Docsie permite que os nossos utilizadores traduzam a sua documentação de produto para vários idiomas. Além disso, com a funcionalidade de seletor de idioma do Docsie, os teus clientes podem escolher o idioma que melhor lhes convém. Isto é extremamente útil para alcance global e para expandir a base de clientes da empresa, enquanto constróis confiança com os teus clientes recém-encontrados no estrangeiro.
Capacidade de atribuir tarefas e comentar para uma colaboração perfeita: O Docsie tem ferramentas incríveis para colaborar com a tua equipa de documentação de produto. Podes atribuir comentários, definir tarefas e atribuir funções para gerir melhor quais tarefas são realizadas por qual utilizador que está a trabalhar no teu projeto de documentação de produto com o Docsie. Para saber mais, consulta este blog aqui.
Geração de feedback: Ser capaz de saber o que os teus clientes pensam sobre a tua documentação é a única forma de saber como otimizar a documentação do teu produto para corresponder às necessidades dos teus clientes, para que possam compreender mais agradavelmente a tua documentação de produto e portais de conhecimento. Para saber mais sobre a importância do feedback sobre a documentação de produto, consulta o meu blog aqui.
Existem também muitas outras funcionalidades e capacidades que o Docsie permite a ti e à tua equipa de gestão de produto utilizar para criar documentação de produto incrível. Neste artigo, gostaria de abordar os plugins que cada portal de conhecimento e documentação de produto do Docsie pode adicionar à sua documentação para melhorá-la e melhorar a sua usabilidade geral.
Plugins do Docsie para tornar o teu portal de documentação dinâmico!¶
O Docsie tem vários plugins que podes usar para tornar a tua documentação mais atraente. Neste blog, vou dividi-lo em 3 partes.
Nesta secção vamos dividir a explicação destes plugins de portal de conhecimento em três partes.
PARTE 1: Na primeira parte mostraremos o 'Display Version Picker', 'Display Language Picker', o 'Display Section Anchors' e o 'Display Footer Navigation'
PARTE 2: Nesta parte mostraremos o 'Code Highlighting', 'Search' e o plugin 'Share to Social Network'
PARTE 3: Na terceira parte mostraremos o 'Image Preview', 'Document Metadata' e o plugin 'Auto-highlight Section'.
Antes de entrarmos nos plugins, vamos falar sobre como aceder a estes plugins dentro da plataforma Docsie.
Primeiro, dentro do espaço de trabalho, precisamos de clicar nos três pontos no canto superior direito e abrir a nossa conta:
Depois, dentro de Deployments, podemos aceder aos Plugins depois de criar um novo Deployment através de 'Configure a new deployment+'
Depois clica em 'More options', o que te permitirá adicionar estes plugins à tua documentação implementada através de um script incorporado ou através do portal Docsie
A outra opção é aceder aos plugins dos portais de conhecimento do Docsie através do botão 'Update deployment configuration' abaixo da tua documentação já publicada.
Isto abrirá este painel e poderás adicionar ou remover plugins conforme necessário e depois atualizar a implementação.
PARTE 1:¶
Agora que sabemos como aceder ao Plugin Docsie, vamos entrar na PARTE 1.
Para ver o tutorial em vídeo da parte 1, consulta este vídeo aqui:
Vamos começar com o 'Display Version Picker' e o 'Display Language Picker'
Uma vez ativados, estes dois aparecerão no canto inferior esquerdo do teu portal de conhecimento como separadores flutuantes. Permitem que os teus clientes e quem lê a tua documentação de produto vejam os teus documentos em diferentes idiomas e versões.
Quando o utilizador pressiona o Idioma no seletor de idioma, toda a documentação que está a ler mudará para esse idioma.
O Display Section anchor, quando ativado, permite que o teu cliente tenha links ao lado de cada cabeçalho, que lhe darão links para certas secções da documentação.
Cada vez que estes links são pressionados, uma parte do cabeçalho mudará e quando o teu cliente copiar e colar este html, ele direcionará a pessoa para quem está a enviar para esta secção específica da documentação.
A seguir é o 'Display Footer Navigation'
Este plugin adiciona um botão de navegação no canto inferior direito do teu Livro de documentação. Tem um aspeto assim:
Desta forma, os teus clientes podem navegar mais confortavelmente pela tua documentação.
PARTE 2:¶
Para ver o tutorial em vídeo da Parte 2, consulta este vídeo aqui:
Nesta parte vamos mostrar os plugins 'Code Highlighting', 'Search' e 'Share to Social Network'
Vamos começar com o plugin 'Code Highlighting'
Este plugin é ótimo para produtos técnicos que precisam de expressar vários códigos aos seus clientes. Este plugin permite que os clientes copiem e colem o código atribuído para que possam usá-lo no seu editor com facilidade, adicionando um botão "Copiar".
Agora vamos explorar o plugin Search.
Uma vez ativado no teu portal de conhecimento Docsie, os teus clientes podem pesquisar pela tua documentação através de uma navegação de pesquisa no canto superior direito do portal de conhecimento.
Ao clicarem em pesquisa, isto mostrará um painel sofisticado que permitirá aos teus clientes identificar exatamente onde encontrar certas informações dentro da tua prateleira e livros.
Isto acelera muito o processo pelo qual os teus clientes podem encontrar e recuperar as informações necessárias sobre os teus produtos.
A seguir é o plugin Share To Social Networks
Este plugin permite que os teus clientes peguem em secções destacadas da tua documentação de produto escrita e as partilhem nas suas redes sociais.
Isto é ótimo porque pode aumentar o tráfego, novos clientes potenciais e a confiança geral na tua marca.
PARTE 3:
Para ver o tutorial em vídeo da parte 3, consulta este vídeo aqui:
Na terceira parte vamos mostrar os plugins 'Image Preview', 'Document Metadata' e 'Auto-highlight Section'.
Vamos começar com o Plugin Image Preview
O Image Preview permite que os teus clientes ampliem ou reduzam uma imagem da tua documentação de produto para visualizá-la melhor.
A seguir é o 'Documentation metadata'
Isto permite que os nossos clientes vejam um carimbo de data/hora quando a documentação do produto ou aspetos do portal de conhecimento foram atualizados. Estará localizado no topo e no fundo da documentação escrita.
Agora vamos ver o Plugin 'Auto-Highlight Section'
Este plugin simples permite que os teus clientes acompanhem onde estão numa determinada documentação dentro do portal de conhecimento.
Destacará cada localização em que estão, dentro do portal de conhecimento, para que os teus clientes possam melhor acompanhar em que secção estão e navegar mais facilmente para outras secções.
Todas estas ferramentas e mais são fornecidas pela plataforma Docsie. Se ainda não experimentaste, sugerimos que o faças. Clica aqui
Além disso, se tiveres alguma dúvida, não hesites em contactar-nos em hello@docsie.io