Muitas empresas de tecnologia SaaS têm dificuldades com o processo de desenvolvimento e distribuição de documentação de produtos (manuais de usuário, guias de usuário e/ou tutoriais) para seus consumidores.
Muitas vezes, isso ocorre devido à falta de conhecimento ou de processo sobre o manuseio e a produção adequados de manuais, ou mesmo sobre quem é responsável por eles.
Enquanto houver a necessidade de ferramentas e softwares neste mundo, precisaremos de uma comunicação eficaz para transmitir aos outros o uso, o desenvolvimento, o funcionamento e a arquitetura desses produtos. Se você se pergunta por que isso acontece, a resposta é simples. Isso se deve ao fato de que as habilidades de comunicação técnica são cruciais para coletar informações e permitir que o público compreenda o produto ou a tecnologia de forma mais eficaz.
Enquanto a comunicação no mundo real é feita pela fala, linguagem corporal e expressões emocionais, no mundo virtual a comunicação técnica ocorre por meio da documentação técnica do produto!
O único objetivo da documentação técnica do produto é facilitar a compreensão do usuário sobre a dinâmica de funcionamento e a arquitetura de um produto e de uma tecnologia. É mais como um manual de "como usar" para seus novos funcionários, usuários/clientes e qualquer outra pessoa que precise estar ciente dos métodos de trabalho, uma descrição completa das porcas e parafusos de um produto!
É dever dos gerentes de produto assumir a responsabilidade de desenvolver uma equipe para criar, gerenciar, publicar e manter uma documentação de produto bem elaborada.
Tenho certeza de que todo gerente de produto já disse ou ouviu o seguinte em seu departamento: "A documentação do produto é um componente das obrigações do proprietário do produto"; "Cada equipe de desenvolvimento deve documentar seus próprios aplicativos"; "o recurso foi implantado, o manual foi atualizado?" ou, muito pior, "há um erro na documentação técnica".
Claramente, a documentação técnica do produto pode ser um pouco confusa, por mais simples que pareça! Enquanto as pessoas tentam resolver ou argumentar sobre as linhas do parágrafo anterior, os manuais e tutoriais se deterioram, o que é prejudicial para a imagem de seu "produto/empresa".
Para ajudar qualquer pessoa que esteja enfrentando problemas semelhantes, aqui estão alguns procedimentos a serem implementados para otimizar a documentação de seu produto.
Qual é o objetivo da documentação do produto?
Quando se fala em documentação de produto para um produto ou serviço tecnológico, está se falando das informações que o descrevem e dos dados relativos a ele.
A documentação técnica, ou documentação do produto, tem como objetivo ajudar seu público e seus clientes a utilizar, ler, entender e usar seu produto. A maioria das documentações de produtos, é claro, é produzida em diversas áreas, incluindo engenharia, medicina, tecnologia da informação e marketing.
Uma excelente documentação técnica de produto ajuda seu público a navegar pelo produto e permite que ele o utilize sem complicações.
Outra consideração é que a documentação técnica é fundamental para a assistência ao cliente e contribui significativamente para a marca e a confiança de sua empresa. Quando mais precisam, os usuários procuram a documentação técnica. O público usa seu produto para aprender sobre os processos e lidar com os problemas.
Isso significa que é muito importante ter uma documentação completa e abrangente do produto que seja dinâmica com recursos de pesquisa
Quais são as diferentes documentações de produtos?
Esta seção permite que você veja que tipo de documentação de produto é necessária para seus clientes ou consumidores.
Há muitos tipos diferentes de documentação de produtos que atendem às necessidades de diferentes tipos de casos de uso e necessidades do usuário:
Documentação do usuário do produto: Consiste em manuais do usuário, guias de instruções, tutoriais, perguntas frequentes, notas de versão e manuais de treinamento, bem como procedimentos operacionais.
Documentação corporativa: Pesquisas mostram que mais de 8 em cada 10 empresas, de 1000 empresas pesquisadas, usam políticas formais e manuais de procedimentos.
Há muitas outras documentações corporativas que compreendem a documentação referente às políticas e aos procedimentos da empresa, conforme indicado na pesquisa acima, manuais de instrução, práticas técnicas, documentação comportamental e ética. Além de documentação jurídica que pode ser protegida por senha. Além disso, as estruturas, as práticas recomendadas e os procedimentos da empresa, bem como os manuais de manutenção
Documentação do desenvolvedor: esse 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 no fluxo de trabalho do desenvolvedor.
Agora que entendemos melhor os diferentes tipos de documentação técnica e de produto, vamos discutir quais são as primeiras etapas de um processo sólido de gerenciamento do desenvolvimento da documentação do produto.
Localizar um responsável pelo desenvolvimento da documentação do produto
Um problema muito comum é determinar quem deve ser o responsável pela documentação do produto, não como alguém que apenas a atualiza, mas como alguém que é responsável pela qualidade e pelo sucesso do produto.
Embora algumas empresas acreditem que cada proprietário e/ou gerente de produto seja responsável pela documentação do produto, outros departamentos, como os de desenvolvimento e suporte, também podem ser encarregados da responsabilidade de manter atualizados e eficazes os manuais e guias do usuário e todas as facetas da documentação do produto.
O desenvolvimento da documentação do produto tem muitas partes móveis, mas aqui apontaremos duas delas:
-
Quem entende como o produto funciona em todos os níveis (isso inclui também as equipes de desenvolvimento e especificações do produto).
-
Aqueles que recebem informações dos clientes que examinam a documentação do produto e ouvem suas dificuldades, feedback e preocupações sobre a compreensão da documentação do produto em questão.
A primeira parte nos ajuda a criar a documentação do produto alocada 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.
Às vezes, esses dois pontos não estão perfeitamente alinhados, o que gera 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, dos manuais do produto e dos guias do usuário. Considere um pedido de compra que tenha "Documentação do produto" como seu produto. Ele é responsável por analisar todas as equipes da empresa, esboçar como cada produto gera seus guias e identificar os desafios associados a esse processo.
A intenção não é que esse proprietário e gerente de produto seja totalmente responsável pela geração e modificação de manuais, mas que auxilie os indivíduos de cada equipe no gerenciamento de documentos.
Esse indivíduo deve estudar como os usuários interagem com os documentos, oferecer maneiras de tornar as atualizações mais fluidas e coletar feedback para determinar como aprimorar a documentação e os explicadores de cada produto para o público-alvo.
Ter alguém encarregado de todas as facetas da documentação do produto, gerenciando o fluxo de trabalho e os diferentes departamentos necessários para concluir essa documentação aumentará a produtividade na empresa, estabelecerá a conscientização e a educação dos clientes com portais de conhecimento sobre o produto e, acima de tudo, simplificará a compreensão do produto.
Veja a documentação do seu produto como o próprio produto.
Os produtos existem para oferecer um grau de valor que atenda ou exceda 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 estão procurando informações sobre produtos que estão pensando em comprar.
Considere os fatores que contribuem para a atratividade de um produto. Há vários fatores que podem afetar a atratividade de um produto, mas, para fins deste artigo, vamos nos concentrar em três. Eles superam as expectativas em termos de valor; seu uso gera satisfação; e são competitivos.
Além disso, os mesmos conceitos se aplicam à boa documentação on-line do produto. Os documentos de produtos que vão "além do valor previsto" ilustram não apenas como usar o item especificado, mas também oferecem soluções que o cliente não conhece ou não acredita serem possíveis. É sempre necessário ver como outras empresas iniciam a documentação de seus produtos para aprender com seus sucessos e erros.
Não faz sentido ter uma empresa que desenvolva um software exclusivo e de alta qualidade, que esteja à frente da concorrência, se os desenvolvedores e clientes que integram os documentos técnicos de seus produtos não conseguirem compreendê-los.
Considere que a pessoa que está lendo a documentação do produto pode não estar familiarizada com a gama de possíveis soluções oferecidas pelo produto ou com o mercado (como é comum no caso de produtos técnicos de SaaS) e, portanto, precisa ser "educada" sobre essas soluções e as várias opções relacionadas ao produto.
Os documentos do produto cuja "usabilidade gera satisfação" seguem um padrão de leitura lógico e adequado ao público-alvo. Não adianta ter o manual mais completo do mundo se ele for um PDF de 500 páginas ou não incluir um exemplo de código e não for criado dinamicamente com recursos de pesquisa e outras funções. Colete feedback dos usuários do documento do seu produto e da equipe de suporte. Eles verificarão as principais áreas de estresse relacionadas aos dados relatados.
A documentação de produtos competitivos é aquela que é atualizada continuamente usando as técnicas mais eficazes de troca de informações. Eles têm recursos incríveis, como recursos de pesquisa incorporados, traduções, versões diferentes, imagens incorporadas, vídeos e muito mais!
Mesmo que o seu guia de integração seja o mais bem escrito de todas as empresas de tecnologia, ele não terá a atração necessária sem um vídeo adicional e imagens e códigos que possam ser copiados e colados para facilitar o uso por seus clientes experientes em tecnologia que compram seus produtos SaaS técnicos.
É sempre necessário ver como outras empresas iniciam seus trabalhos para aprender com seus sucessos e erros.
Não faz sentido ter uma empresa que desenvolva um software exclusivo e de alta qualidade que esteja à frente da concorrência se os desenvolvedores e clientes que integram seus documentos não conseguirem compreendê-los em sua totalidade.
Feedback sobre a documentação do produto
A documentação técnica eficaz do produto aprimora a experiência do usuário final ao aperfeiçoar o processo de compreensão dos produtos e diagnosticar quaisquer problemas com soluções escritas prontamente disponíveis. Quando os clientes confiam e entendem como usar seus produtos, eles podem voltar a procurá-lo no futuro, quando houver necessidade.
Uma nova pesquisa realizada pela SDL demonstra que o papel da documentação nos mercados mundiais está aumentando. 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 dessa pesquisa mostra que 94% dos compradores acham que ter informações sobre o produto em um único local é útil e proveitoso. Por esse motivo, atualmente, todas as empresas dão a mesma ênfase à documentação do produto, bem como ao desenvolvimento ou teste do produto.
Mesmo que a documentação tenha um proprietário designado que gerencie a equipe de documentação, que eles tenham criado a documentação do produto que foi revisada e avaliada para melhorar a usabilidade e que tenha sido atualizada adequadamente, você continua tendo dificuldades para fazer com que seus usuários e consumidores compreendam seus produtos técnicos. Isso pode ocorrer como resultado da incapacidade dos usuários/leitores de compreender como os documentos estão sendo lidos ou as perguntas que eles realmente estão fazendo. Isso faz com que um dos aspectos mais desafiadores da composição de documentos seja colocar-se no lugar do leitor. Afinal, quem produz a documentação do produto deve ter uma sólida compreensão do produto.
Essa experiência pode fazer com que o redator deixe passar coisas que não são tão óbvias para o usuário comum. Normalmente, isso ocorre quando algo que é evidente para as pessoas que criam o produto não é muito claro para quem compra e usa o produto.
Isso pode ocorrer de várias maneiras:
Estrutura ou forma de redação: Embora essa possa parecer uma palavra subjetiva, até mesmo a maneira como um manual é escrito pode gerar confusão. É fundamental identificar o tipo de leitor que lê a documentação; caso contrário, podem ocorrer palavras como "Os desenvolvedores preferem exemplos a textos descritivos" ou "Nossa documentação não é clara, apesar da presença de exemplos e recursos visuais".
Tópico organizado em manuais: Ocasionalmente, as empresas que operam no mesmo mercado desenvolvem um formato de documentação padronizado. Se os guias de sua empresa não aderirem a ele, o leitor poderá 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. Utilize designações específicas, como "UserID", em vez de "UID".
Tradução válida: a tradução é uma grande parte do alcance global. Muitas vezes, as empresas criam manuais de usuário e documentação de produtos mal traduzidos que não correspondem à cultura de determinadas nações ou simplesmente as palavras não são traduzidas da mesma forma que seriam em inglês para aquele país específico. Compreender essas nuances sutis pode fazer com que a documentação do produto passe de uma informação ilegível para uma documentação de produto totalmente abrangente e traduzida.
Para evitar essas situações, o objetivo é desenvolver uma solução que reúna e analise o feedback do usuário e os padrões de navegação.
Ferramentas de feedback, como o recurso Vocally a Docsie, são uma ótima maneira de receber e avaliar padrões de navegação e pesquisar como seus clientes estão vendo a documentação do produto. Conheça as 7 regras de ouro da coleta de feedback aqui.
Essas informações são essenciais para atualizar e otimizar seus guias de usuário, manuais de usuário e documentação de produtos, a fim de criar uma experiência mais perfeita para que seus clientes conheçam seus produtos. Nada é mais frustrante do que introduzir um novo produto e descobrir um aumento nas solicitações de suporte devido à falta de instruções no manual.
Como escrever uma documentação abrangente sobre o produto
A documentação de produtos de qualidade é cativante, útil e poderosa. Eu diria que a documentação adequada é um componente necessário para um bom gerenciamento de produtos. Por mais que os gerentes de produtos tenham uma grande participação no desenvolvimento de produtos, uma parte significativa do sucesso é a criação de uma documentação de produto incrível e polida que nossos clientes possam compreender e usar para aprofundar seus conhecimentos sobre nossos produtos.
O que está acontecendo com a maioria das documentações de produtos?
Muitos gerentes de produtos são avessos à elaboração de documentos de produtos. Os documentos de produtos com os quais eles estão familiarizados podem não ter tração com seus clientes, a menos que se tome mais cuidado para torná-los atraentes, fáceis de ler e de se relacionar.
Entretanto, muitas vezes as empresas não tomam o cuidado necessário para criar e elaborar uma documentação de produto incrível. Uma documentação de produto ruim é escrita com o único propósito de ser escrita. Ela emprega frases extensas cheias de pensamentos vagamente aceitáveis e um layout ruim para desencorajar os espectadores a interagir com o material. Uma documentação de produto ruim é criada para proteger o autor de críticas e é uma completa perda de tempo para todos. E seus clientes também não gostam de lê-la por esse motivo.
Como podemos corrigir isso e escrever uma documentação de produto melhor, que nossos clientes gostem de ler?
Uma documentação de produto excelente é escrita com a intenção de ser lida. Ela é 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. Ela evita jargões e fornece ou faz referência a pontos de vista de nível comercial. Uma excelente documentação de produto dedica tempo a delinear casos de uso específicos que os clientes podem entender e aplicar ao uso aprimorado do produto. Ela envolve o leitor e chama a atenção para questões subjacentes com soluções bem elaboradas.
O poder de uma documentação de produto bem escrita
Em empresas de pequeno, médio ou grande porte, documentos técnicos de produtos bem formatados podem economizar muito tempo e ajudar os funcionários a trabalhar de forma mais produtiva. Isso geralmente é verdade para a maioria das empresas baseadas em produtos, que gastam uma grande porcentagem de seus orçamentos na contratação de redatores técnicos e na redação de documentação técnica de produtos.
Se sua empresa emprega mais de duas pessoas para criar a documentação do produto, vale muito a pena estabelecer uma cultura de boa documentação. Há muitos motivos para querer que a sua equipe crie, gerencie e publique uma documentação de produto bem elaborada, mas na seção abaixo abordaremos como a documentação eficaz do produto é uma abordagem de baixo custo para melhorar a experiência do cliente.
A documentação eficaz do produto é uma abordagem de baixo custo para melhorar a experiência do cliente
A experiência sólida do cliente é a vanguarda para manter e fidelizar clientes. A maioria dos gerentes de projeto é otimista - eles têm um conceito, ficam entusiasmados e depois o executam. Embora a paixão seja admirável e a execução pareça produtiva, é fundamental ter um plano de jogo antes de executar a documentação adequada do produto.
As primeiras etapas 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 forma que seja progressivamente mais fácil para os clientes lerem.
Além disso, obter feedback dos clientes sobre a documentação atual é uma etapa vital necessária para reestruturar a documentação de modo a atender às necessidades dos clientes. Dessa forma, os gerentes de projeto podem criar, gerenciar, manter, publicar e otimizar sua documentação com percepção e automação. Essa não é uma tarefa simples e minúscula, 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.
Uma 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 que eles configurem e usem o produto corretamente.
Todas essas estratégias de criação de uma documentação de produto bem polida levarão essencialmente a produtos com classificação mais alta, avaliações mais favoráveis e mais vendas, todas vinculadas umas às outras; portanto, não é preciso dizer que o aumento das vendas é o resultado.
Como criar uma documentação de produto bem elaborada
Como produzir uma documentação eficaz e promover uma cultura em que ela seja o padrão? Escrever uma documentação eficaz é um desafio, mas há muitos recursos bons no Docsie que podem ajudar a iniciar esse processo de criação de portais de documentação de produtos bem elaborados e dinâmicos. A seguir, apresentamos um resumo de alto nível de como abordamos a questão.
Agora vamos começar:
As limitações de página garantem a legibilidade. Escrever um documento decente não deve ser difícil de ler e processar mentalmente. Frases longas e sinuosas são frequentemente indicativas de falta de clareza. Se a comunicação não puder ser resumida adequadamente em uma única página, isso é uma indicação de que o gerente de produto provavelmente deve voltar e detalhar melhor a situação.
A formatação melhora a qualidade. Uma documentação de produto mal estruturada aumenta a probabilidade de que o redator a ignore. Crie um modelo com seções, tabelas e cabeçalhos de documentos bem formatados. É um investimento único com alto potencial de dividendos.
Os modelos ajudam você a economizar tempo. É muito mais fácil excluir uma seção de um modelo do que lembrar de adicionar uma. Isso não é paternalista; pelo contrário, é eficaz e economiza tempo. Seções simples que lembram o redator de começar com o histórico geral e de ser específico sobre medidas ou suposições perigosas permitem uma redação mais precisa e uma hierarquia de decisões.
Faça comentários e atribua tarefas Não há maneira mais segura de desmotivar sua equipe a produzir documentação de alta qualidade do que deixar de fazer comentários sobre ela. Os comentários não precisam ser muito inteligentes; em vez disso, eles devem indicar envolvimento e servir de modelo. Embora seja ideal fornecer feedback digitalmente para que outras pessoas na empresa possam se beneficiar de forma assíncrona da conversa, um recurso simples no Docsie que permite comentar e colaborar com a sua equipe funciona muito bem para a equipe de documentação de produtos!
Confira este blog para saber mais sobre como o Docsie ajuda na colaboração da documentação do produto
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/
**À medida que mais partes interessadas se envolvem no processo de desenvolvimento de produtos, a comunicação deve ser dividida em vários documentos (principalmente se o critério de "concisão" de uma página for atendido). O Docsie permite uma solução útil e sustentável para equipes de documentação de produtos em crescimento.
Use o Docsie como uma forma de acelerar a incrível criação da documentação do produto
O Docsie é uma plataforma muito útil que ajuda você em todos os aspectos da documentação do produto e da criação do portal de conhecimento. Ela tem muitos recursos integrados que tornam a criação, a publicação, a manutenção e o gerenciamento de projetos de criação de documentação de produtos realmente simples e divertidos! Aqui estão apenas alguns dos muitos recursos do Docsie que podem ajudá-lo a atingir esses objetivos:
Possibilidade de editar: O Docsie permite que todos os nossos usuários editem a documentação do produto após a publicação, criando uma versão alternativa que não entrará no ar até que esteja ativa. Isso é incrível porque as equipes de gerenciamento de produtos podem trabalhar na edição e na alteração da documentação do produto e, em seguida, torná-la ativa quando estiverem prontas para isso, sem precisar passar por obstáculos de HTML e CSS. Ele renderizará automaticamente a documentação do produto com o simples toque de um botão quando estiver pronta.
Abilidade de pesquisa: Se a documentação do seu produto for abundante ou tiver muitos recursos, o plug-in de pesquisa do Docsies é um bônus útil que permite que os clientes pesquisem a documentação de forma rápida e fácil para encontrar as informações necessárias e acelerar o processo de visualização e absorção de informações da documentação do produto.
Capacidade de criar links: O Docsie torna a documentação de seu produto compatível com SEO. Você pode criar backlinks para determinadas páginas do site da sua empresa ou simplesmente escrever palavras-chave com base nos seus produtos, que poderão ser pesquisadas on-line e atrairão novos clientes que desejam encontrar o mesmo produto que você tem.
Capacidade de ter traduções diferentes: O tradutor fantasma de última geração do Docsie permite que nossos usuários traduzam a documentação de seus produtos para vários idiomas. Além disso, com os recursos de seleção de idiomas do Docsie, seus clientes podem escolher o idioma mais adequado para eles. Isso é muito útil para o alcance global e para expandir a base de clientes das empresas, ao mesmo tempo em que cria confiança com seus clientes recém-fundados e clientes no exterior.
Capacidade de atribuir tarefas e comentários para uma colaboração perfeita: O Docsie tem ferramentas incríveis para colaborar com a equipe de documentação do seu produto. É possível atribuir comentários, definir tarefas e atribuir funções para que você possa gerenciar melhor quais tarefas são realizadas por cada usuário que está trabalhando no projeto de documentação do seu produto com o Docsie. Para saber mais, confira este blog aqui.
Geração de feedback: Poder saber o que os clientes estão pensando sobre a documentação é a única maneira de saber como otimizar a documentação do produto para atender às necessidades dos clientes, de modo que eles possam compreender de forma mais agradável as documentações do produto e os portais de conhecimento Para saber mais sobre a importância do feedback da documentação do produto, consulte meu blog aqui.
Há também muitos outros recursos e capacidades que o Docsie permite que você e sua equipe de gerenciamento de produtos usem para criar uma documentação de produto incrível. Neste artigo, gostaria de abordar os plug-ins que cada portal de conhecimento e documentação de produto do Docsie pode adicionar às suas documentações para aprimorá-las e melhorar sua usabilidade geral.
Plug-ins do Docsie para dinamizar seu portal de documentaçãoO Docsie tem vários plug-ins que você pode usar para tornar sua documentação mais atraente. Neste blog, vou dividi-lo em três partes.
Nesta seção, dividiremos a explicação desses plug-ins do portal de conhecimento em três partes.
PARTE 1: Na primeira parte, mostraremos o que o 'Display Version Picker', o 'Display Language Picker', o 'Display Section Anchors' e o 'Display Footer Navigation
**PARTE 2: Nessa parte, mostraremos o plug-in "Code Highlighting", "Search" e o plug-in "Share to Social Network".
PARTE 3: Na terceira parte, mostraremos o plug-in "Image Preview", "Document Metadata" e o plug-in "Auto-highlight Section".
Antes de entrarmos nos plug-ins, vamos falar sobre como acessar esses plug-ins na plataforma Docsie.
Primeiro, no espaço de trabalho, precisamos clicar nos três pontos no canto superior direito e abrir nossa conta:
Em seguida, nas implantações, podemos acessar os plug-ins depois de criarmos uma nova implantação por meio de "Configurar uma nova implantação+
Em seguida, clique em "More options" (Mais opções), o que permitirá adicionar esses plug-ins à documentação implantada por meio de um script incorporado ou do portal Docsie
A outra opção é acessar os plug-ins dos portais de conhecimento do Docsie por meio do botão "Atualizar configuração de implantação" abaixo da documentação já publicada.
Ele abrirá esse painel e, em seguida, você poderá adicionar ou remover plug-ins conforme achar necessário e atualizar a implantação.
PARTE 1:
Agora que sabemos como acessar o Docsie Pluggin, vamos pular para a PARTE 1.
Para ver o tutorial em vídeo da parte 1, confira este vídeo aqui:
Vamos começar com o "Seletor de versão de exibição" e o "Seletor de idioma de exibição
Quando essas duas opções estiverem ativas, elas aparecerão no canto inferior esquerdo do portal de conhecimento como guias flutuantes. Elas permitem que seus clientes e aqueles que estão lendo a documentação do produto visualizem os documentos do produto em diferentes idiomas e versões.
Quando o usuário pressionar o idioma no seletor de idiomas, toda a documentação que estiver lendo será alterada para esse idioma.
A âncora Display Section (Exibir seção), uma vez ativada, permite que o cliente tenha links ao lado de cada cabeçalho que fornecerão links para determinadas seções da documentação.
Toda vez que esses links forem pressionados, uma parte do cabeçalho será alterada e, quando o cliente copiar e colar esse html, ele direcionará a pessoa a quem está enviando para essa seção específica da documentação.
O próximo passo é "Exibir navegação no rodapé
Esse plug-in adiciona um botão de navegação na parte inferior direita do seu livro de documentação. Ele tem a seguinte aparência.
Dessa forma, seus clientes podem navegar mais confortavelmente pela sua documentação.
PARTE 2:
Para ver a Parte 2 do vídeo tutorial, confira este vídeo aqui:
Nesta parte, mostraremos o plug-in "Code Highlighting" (Realce de código), "Search" (Pesquisa) e "Share to Social Network" (Compartilhar em redes sociais)
Agora vamos começar com o plug-in "Code Highlighting" (Destaque de código)
Esse plugin é ótimo para produtos técnicos que precisam expressar vários códigos para seus clientes. Esse plugin permite que os clientes copiem e colem o código alocado para que possam usá-lo em seu editor para facilitar o uso, adicionando um botão "Copy" (Copiar).
Agora vamos nos aprofundar no plug-in Search.
Uma vez ativado no portal de conhecimento do Docsie, seus clientes podem pesquisar sua documentação por meio de uma navegação de pesquisa no canto superior direito do portal de conhecimento.
Ao clicar em pesquisar, será exibido um painel sofisticado que permitirá que seus clientes identifiquem exatamente onde encontrar determinadas informações em suas prateleiras e livros.
Isso acelera muito o processo no qual seus clientes podem encontrar e recuperar as informações necessárias sobre seus produtos.
O próximo é o plug-in Share To Social Networks
Esse plug-in permite que seus clientes peguem seções destacadas da documentação escrita do seu produto e as compartilhem nas mídias sociais.
Isso é ótimo porque pode aumentar o tráfego, os novos clientes em potencial e a confiança geral em sua marca.
PARTE 3:
Para ver a parte 3 do vídeo tutorial, confira este vídeo aqui:
Na terceira parte, mostraremos o plug-in "Image Preview" (Visualização de imagem), "Document Metadata" (Metadados do documento) e o plug-in "Auto-highlight Section" (Seção de destaque automático).
Vamos começar com o plug-in de visualização de imagem
A visualização da imagem permite que seus clientes aumentem ou diminuam o zoom de uma imagem da documentação do seu produto para melhor visualizá-la.
O próximo passo é "Metadados da documentação
Isso permite que nossos clientes vejam um registro de data e hora quando a documentação do produto ou aspectos do portal de conhecimento foram atualizados. Ele estará localizado na parte superior e inferior da documentação escrita.
Agora vamos dar uma olhada no plug-in "Auto-Highlight Section Plugin
Esse plug-in simples permite que seus clientes acompanhem onde estão em uma determinada documentação no portal do conhecimento.
Ele destacará cada local em que se encontram, dentro do portal do Conhecimento, para que os clientes do yo8ru possam acompanhar melhor a seção em que se encontram e navegar mais facilmente por outras seções.
Todas essas ferramentas e outras são fornecidas a você pela plataforma Docsie. Se você ainda não a experimentou, sugerimos que o faça. Clique aqui
Se tiver alguma dúvida, sinta-se à vontade para entrar em contato conosco em hello@docsie.io