Numerosas empresas tecnológicas SaaS debatem-se com o processo de desenvolvimento e distribuição de documentação de produtos (manuais de utilização, guias de utilização e/ou tutoriais) aos seus consumidores.
Muitas vezes, isto ocorre como resultado de uma falta de conhecimento ou processo sobre o manuseamento e produção adequados de manuais, ou mesmo sobre quem é responsável por eles.
Enquanto existir a necessidade de ferramentas e software neste mundo, será necessária uma comunicação eficaz para transmitir eficazmente a outros a utilização, desenvolvimento, funcionamento e arquitectura destes bens. Se se perguntar porquê, a resposta é simples. É devido ao facto de as competências técnicas de comunicação serem cruciais para recolher informação e permitir ao público compreender o produto ou a tecnologia de forma mais eficaz.
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 tem lugar através da documentação técnica do produto!
O único objectivo da documentação técnica do produto é facilitar ao utilizador a compreensão da dinâmica de trabalho e da arquitectura de um produto e tecnologia. É mais como um manual "como utilizar" para os seus novos trabalhadores, utilizadores/clientes e qualquer outra pessoa que tenha de estar ciente dos métodos de trabalho, uma descrição completa da porca e dos parafusos de um produto!
É dever dos gestores do produto assumir a responsabilidade de desenvolver uma equipa para criar, gerir, publicar e manter a documentação do produto polido.
Estou certo de que todos os gestores de produto disseram ou ouviram o seguinte no seu departamento: "A documentação do produto é um componente das obrigações do proprietário do produto"; "Cada equipa de desenvolvimento deve documentar as suas próprias aplicações"; "a funcionalidade foi implementada, o manual foi actualizado?" 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 indivíduos tentam resolver ou discutir sobre as linhas do parágrafo anterior, os manuais e tutoriais deterioram-se, o que é prejudicial para a sua imagem de "produto/empresa".
Para ajudar qualquer pessoa com problemas semelhantes, aqui estão alguns procedimentos a implementar para optimizar a documentação do seu produto.
Qual é a finalidade da documentação do produto?
Quando se fala de documentação de produto para um produto ou serviço tecnológico, fala-se da informação que o descreve e dos dados que lhe dizem respeito.
A documentação técnica, ou documentação do produto, tem tudo a ver com ajudar o seu público e os clientes a utilizar, ler, compreender, e utilizar o seu produto. A maioria da documentação do produto, claro, é produzida em diversas áreas, incluindo engenharia, medicina, tecnologia da informação e marketing.
A grande documentação técnica do produto ajuda o seu público a navegar no seu produto e permite a sua utilização sem complicações.
Uma outra consideração é que a documentação técnica é fundamental para a assistência ao cliente e contribui significativamente para a marca e confiança da sua empresa. Quando estão mais necessitados, os utilizadores procuram documentação técnica. O público utiliza o seu produto para aprender sobre os processos e lidar com os problemas.
Isto significa que é muito importante ter uma documentação de produto completa e abrangente, dinâmica e com capacidades de pesquisa.
Quais são as diferentes documentações de produtos
Esta secção permite-lhe ver de que tipo de documentação de produto necessita para os seus clientes ou clientes.
Existem muitos tipos diferentes de documentação de produtos que satisfazem a necessidade de diferentes tipos de casos de utilização e necessidades dos utilizadores:
Produto Documentação do utilizador: Consiste em manuais do utilizador, guias de instruções, tutoriais, FAQs, notas de lançamento, e manuais de formação, bem como procedimentos operacionais.
Documentação empresarial: Os inquéritos mostram que mais de 8 em cada 10 empresas, de 1000 empresas inquiridas, utilizam políticas formais e manuais de procedimentos.
Há muita outra documentação empresarial que inclui documentação referente às políticas e procedimentos das empresas, como indicado na pesquisa acima, manuais de instrução, práticas técnicas, documentação comportamental e ética. Assim como documentação legal que poderia ser protegida por senha. Também as estruturas, melhores práticas e procedimentos das empresas, bem como os manuais de manutenção
Developer Documentation: 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 ajudar no fluxo de trabalho do desenvolvedor.
Agora que compreendemos melhor os diferentes tipos de documentação técnica e de produto, vamos discutir com que começam os primeiros passos de uma gestão sólida do processo de desenvolvimento de documentação de produto.
Localizar um chefe de desenvolvimento de documentação do produto
Uma questão muito típica é determinar quem deve ser responsável pela documentação do produto, não como alguém que apenas a actualiza, mas como alguém que é responsável pela qualidade e sucesso do produto.
Enquanto algumas empresas acreditam que cada proprietário e/ou gestor de produto é responsável pela documentação do produto, bem como outros departamentos, tais como documentos de desenvolvimento e suporte, pode também ser confiada a responsabilidade de manter os manuais de utilizador, guias de utilizador e todas as facetas da documentação do produto actuais e eficazes.
O desenvolvimento da documentação do produto tem muitas partes móveis, mas aqui vamos apontar duas delas:
-
Quem compreende como o produto funciona a todos os níveis (isto inclui também as equipas de desenvolvimento e especificações do produto).
-
Aqueles que recebem contributos de 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 atribuído com os conhecimentos em mãos, e isto é enviado ao cliente que em troca dá feedback e inicia os segundos processos que ajudam a optimizar a documentação.
Por vezes, estes dois pontos não estão perfeitamente no lugar, e isto produz situações em que a documentação do produto nunca recebe a atenção necessária.
Uma abordagem é designar uma pessoa a ser responsável pelo "desempenho", documentação do produto, manuais de produto e guias de utilizador. Considerar uma ordem de compra que tenha como produto "Documentação de Produto". Ele é responsável por passar por todas as equipas da empresa, desenhando a forma como cada Produto gera os seus guias e identificando os desafios associados a esse processo.
A intenção não é que o proprietário e o gestor do produto sejam inteiramente responsáveis pela geração e modificação de manuais, mas sim que ajudem os indivíduos dentro de cada equipa na gestão de documentos.
Este indivíduo deve estudar a forma como os utilizadores interagem com os documentos, oferecer formas de tornar as actualizações mais fluidas, e recolher feedback para determinar como melhorar a documentação de cada produto e explicadores com o seu público alvo.
Ter alguém responsável por todas as facetas da documentação do produto, gerir o fluxo de trabalho, e os diferentes departamentos que são necessários para completar esta documentação, aumentará a produtividade dentro da empresa, estabelecendo uma consciencialização e educando os clientes com portais de conhecimento sobre o produto e sobre toda a racionalização da compreensão do produto.
Veja a documentação do seu produto como produto em si.
Os produtos existem para fornecer um grau de valor que satisfaz ou excede as expectativas de um cliente. Com base estatísticas geradas por D2WorldWide 73,7% de pessoas avaliam a documentação mais útil do que vídeos, embalagens ou vendedores quando procuram informações sobre produtos que estão a considerar na compra.
Considerar os factores que contribuem para a atractividade de um produto. Há vários factores que podem afectar a atractividade de um produto, mas para bem deste artigo, concentrar-nos-emos em três. Eles 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 à boa documentação de produtos em linha. Documentos de produtos que vão "além do valor previsto" ilustram não só como utilizar o item especificado, mas também oferecem soluções que o cliente desconhece ou sente que não são possíveis. É sempre necessário ver como outras empresas iniciam a sua documentação de produto para aprender com os seus sucessos e erros.
É inútil ter uma empresa que desenvolve software único e de alta qualidade que esteja à frente da concorrência se os criadores e clientes que integram os seus documentos técnicos de produto não os conseguirem apreender.
Considerar que a leitura individual da 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 é normalmente o caso dos produtos técnicos SaaS), pelo que devem ser "educados" sobre essas soluções e várias opções relacionadas com o produto.
Os documentos de produtos cuja "usabilidade gera satisfação" seguem um padrão de leitura lógico 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 se não incluir um exemplo de Código e não for criado de forma dinâmica com capacidades de pesquisa, e outras funções. Recolha feedback dos utilizadores do seu documento de produto e do seu pessoal de apoio. Eles verificarão as principais áreas de stress ligadas aos dados comunicados.
A documentação competitiva do produto é aquela que é continuamente actualizada utilizando as técnicas de troca de informação mais eficazes. Têm características surpreendentes, tais como capacidades de pesquisa, traduções, diferentes versões, imagens incorporadas, vídeos, e muito mais!
Mesmo que o seu guia de integração seja o melhor escrito de todas as empresas tecnológicas, faltar-lhe-á a atracção sem um vídeo adicional, e imagens e códigos que podem ser copiados e colados para facilitar a sua utilização pelos seus clientes com conhecimentos técnicos que adquirem os seus produtos técnicos SaaS.
É sempre necessário ver como outras empresas iniciam os seus trabalhos a fim de aprenderem com os seus sucessos e erros.
Não faz sentido ter uma empresa que desenvolve software único e de alta qualidade que esteja à frente da concorrência se os programadores e clientes que integram os seus documentos não forem capazes de os apreender na sua totalidade.
O feedback da documentação do produto*
A documentação técnica eficaz do produto melhora a experiência do utilizador final ao polir o processo para compreender os produtos e diagnosticar quaisquer problemas com soluções escritas prontamente disponíveis. Quando os clientes confiam e entendem como utilizar os seus produtos, poderão voltar a utilizá-los no futuro, quando surgir a necessidade.
Nova pesquisa feita pela SDL demonstra que o papel da documentação nos mercados mundiais está a aumentar. A pesquisa mostra que cerca de 53% dos compradores fazem compras utilizando literatura técnica antes de experimentarem o produto. Além disso, outra estatística compilada a partir desta pesquisa mostra que 94% dos compradores sentem que ter informação sobre o produto num único local é útil e útil. Devido a isto, cada empresa dá igual ênfase à documentação do produto, bem como ao desenvolvimento ou teste do produto nos dias de hoje.
Mesmo que a documentação tenha um proprietário designado que gere a equipa de documentação, criaram documentação de produtos que foi revista e avaliada para melhorar a usabilidade, e que foi devidamente actualizada, continua a ter dificuldades em fazer com que os seus utilizadores e consumidores compreendam os seus produtos técnicos. Isto pode surgir como resultado da incapacidade dos utilizadores/leitores de compreenderem como os seus documentos estão a ser lidos ou as questões que realmente lhes são colocadas. Isto faz com que um dos aspectos mais desafiantes da composição de documentos seja colocar-se no lugar do leitor. Afinal de contas, quem produz a documentação do produto deve ter uma compreensão sólida do produto.
Esta perícia pode levar o escritor a ignorar coisas que não são tão óbvias para o utilizador médio. Tipicamente, isto ocorre quando algo que é evidente para as pessoas que criam o produto não é muito claro para aqueles que compram e utilizam o produto.
Isto pode acontecer de várias maneiras:
Estrutura ou forma de escrita: Embora esta possa parecer ser uma palavra subjectiva, mesmo a forma como um manual é escrito pode criar confusão. É fundamental identificar o tipo de leitor que lê a documentação; caso contrário, podem ocorrer palavras como "Desenvolvedores preferem exemplos a textos descritivos" ou "A nossa documentação não é clara apesar da presença de exemplos e visuais".
Tópico organizado em manuais: Ocasionalmente, as empresas que operam no mesmo mercado desenvolvem um formato de documentação padronizado. Se os guias da sua empresa não aderirem a ele, o leitor pode ter uma sensação de estranheza.
O uso excessivo de termos implícitos: Quando aplicadas a um manual, as abreviaturas podem fazer pouco sentido, mesmo que as frases não sejam acrónimos. É difícil de perceber, mas algumas palavras, tais como "status", "id", "credenciais", e contêm um significado implícito disfarçado de explícito. Utilizar designações particulares, tais 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 produtos mal traduzidos e que não correspondem à cultura de certas nações ou simplesmente as palavras não traduzem da mesma forma que traduziriam em inglês para aquele país em particular. A compreensão destas nuances subtis pode levar a documentação do produto a um longo caminho, desde informação ilegível até uma documentação do produto totalmente abrangente e traduzida.
Para evitar tais situações, o objectivo é desenvolver uma solução que reúna e analise o feedback dos utilizadores e os padrões de navegação.
Ferramentas de feedback como a funcionalidade Vocally a Docsie é uma óptima forma de reanimar e avaliar os padrões de navegação e de pesquisar a forma como os seus clientes estão a visualizar a documentação do seu produto. Aprenda aqui as 7 regras de ouro da recolha de feedback
Esta informação é fundamental para actualizar e optimizar os seus guias de utilizador, manuais de utilizador e documentação de produtos, de modo a criar uma experiência mais perfeita para os seus clientes aprenderem sobre os seus produtos. Nada é mais frustrante do que introduzir um novo produto e descobrir um aumento nos pedidos de apoio devido a más instruções manuais.
Como Escrever Documentação Abrangente do Produto
A documentação de qualidade do produto é cativante, útil e poderosa. Eu diria que uma documentação adequada é uma componente necessária para uma boa gestão do produto. Por mais que os gestores de produto tomem um enorme papel no desenvolvimento de produtos, uma parte significativa do sucesso está a criar uma incrível documentação de produto polido que os nossos clientes podem compreender e utilizar para aprofundar os seus conhecimentos sobre os nossos produtos.
O que se passa com a maioria da documentação do produto?
Muitos gestores de produtos são avessos à elaboração de documentos de produtos. Os documentos dos produtos com que estão familiarizados podem não ter tracção com os seus clientes, a menos que se tenha mais cuidado em torná-los apelativos, fáceis de ler e de relacionar.
No entanto, muitas vezes as empresas não tomam o cuidado necessário para criar e elaborar documentação de produtos espantosos. A má documentação do produto é escrita com a única finalidade de ser escrita. Emprega frases expansivas cheias de pensamentos vagamente aceitáveis e uma má disposição para desencorajar os telespectadores de interagir com o material. Uma documentação de produto pobre é criada para proteger o autor de críticas e é um completo desperdício de tempo de todos. E os seus clientes também não gostam de a ler devido a esta razão.
Como resolver isto e escrever melhor a documentação do produto que os nossos clientes irão gostar de ler?
A excelente documentação do produto é escrita com a intenção de ser lida. É sucinta. A boa documentação do produto está bem formatada e pode ser lida e compreendida por todos na empresa ou pelos clientes em três minutos. Evita o jargão e dá ou faz referência a pontos de vista a nível empresarial. Uma excelente documentação do produto gasta tempo a delinear casos específicos de utilização que os clientes podem compreender e aplicar para uma melhor utilização do produto. Envolve o leitor e chama a atenção para questões subjacentes com soluções bem trabalhadas.
A potência de uma documentação de produto bem escrita
Quando existem pequenas, médias ou grandes empresas, documentos técnicos de produtos bem formatados podem poupar muito tempo e ajudar os empregados 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 escritores técnicos e na redacção de documentação técnica de produtos.
Se a sua empresa emprega mais de dois indivíduos para criar documentação de produtos, estabelecer uma cultura de boa documentação vale completamente a pena. Há muitas razões pelas quais gostaria que a sua equipa criasse, gerisse e publicasse documentação de produtos bem elaborada, mas para a secção abaixo abordaremos a eficácia da documentação de produtos 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 sólida experiência do cliente é a vanguarda para manter e manter clientes fiéis. A maioria dos gestores de projectos são optimistas - obtêm um conceito, tornam-se entusiastas, e depois executam. Enquanto a paixão é admirável, e a execução parece 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 concepção e estruturar o conteúdo da documentação do produto de tal forma que será progressivamente fácil para os seus clientes ler.
Além disso, obter feedback dos seus clientes sobre a sua documentação actual é um passo vital para reestruturar os documentos de modo a corresponder às necessidades dos clientes. Desta forma, os gestores de projecto podem criar, gerir, manter, publicar e optimizar a sua documentação com percepção e automatização. Esta não é uma tarefa simples e minúscula, e ter ferramentas surpreendentes como Docsie que automatiza muitos dos processos para tornar eficaz a documentação do produto é bastante essencial para o sucesso.
A documentação técnica atractiva, envolvente e navegável ajuda os consumidores a aprender o produto em menos tempo, o que aumenta a probabilidade de o configurarem correctamente e o utilizarem correctamente.
Todas estas estratégias de criação de documentação de produtos bem polidos conduzirão essencialmente a produtos com classificações mais elevadas, revisões mais favoráveis, e mais vendas estão todas ligadas umas às outras; por conseguinte, é evidente que o aumento das vendas como resultado.
Como criar documentação de produto bem elaborada
Como produzir documentação eficaz e promover uma cultura onde ela é o padrão? Escrever documentação eficaz é um desafio, mas há muitas características boas no Docsie que podem ajudar a semear este processo de fazer portais de documentação de produtos bem trabalhados e dinâmicos. O que se segue é um resumo de alto nível de como abordamos a questão.
Agora vamos começar:
As limitações da página garantem a legibilidade. Escrever um documento decente não deve ser difícil de ler e processar mentalmente. As frases prolongadas e meandrosas são frequentemente indicativas de uma falta de clareza. Se a comunicação não puder ser devidamente resumida numa única página, é uma indicação de que o gestor do produto deve provavelmente voltar atrás e decompor a situação.
A formação de gordura melhora a qualidade*. Uma documentação de produto mal estruturada aumenta a probabilidade de o escritor a improvisar. Criar um modelo com secções, tabelas, e cabeçalhos de documentos bem formatados. É um investimento único com elevado potencial de dividendos.
Os templates ajudam-no a poupar tempo. É muito mais fácil apagar uma secção de um modelo do que lembrar de adicionar um. Não é paternalista; pelo contrário, é eficaz e poupa tempo. Secções simples que lembram ao escritor para começar com o fundo amplo e ser específico sobre medidas ou suposições perigosas permitem uma escrita mais precisa e uma hierarquia de decisão.
Comentar e atribuir tarefas* Não há maneira mais segura de desmotivar o seu pessoal de produzir documentação de alta qualidade do que não fazer observações sobre eles. Os comentários não precisam de ser muito inteligentes; pelo contrário, devem indicar o envolvimento e servir de modelo. Embora seja ideal fornecer feedback digitalmente para que outros na empresa possam beneficiar assincronamente da conversa, uma funcionalidade simples em Docsie que lhe permite comentar e colaborar com a sua equipa trabalha muito bem a equipa de documentação do produto!
Veja este blog para saber mais sobre como a Docsie ajuda na Colaboração de Documentação de Produto
https://www.docsie.io/blog/articles/collaboration-to-create-well-polished-product-documentation/*
Os tipos de documentos devem ser escaláveis para satisfazer as exigências da sua empresa. À medida que mais intervenientes se envolvem no processo de desenvolvimento do produto, a comunicação deve ser dividida em vários documentos (particularmente se se pretende cumprir o critério de "concisão" de uma página). Docsie permite uma solução útil e sustentável para as equipas de documentação de produtos em crescimento.
Use Docsie como uma forma de acelerar a criação de documentação de produtos espectaculares
Docsie é uma plataforma muito útil que o ajuda em todos os aspectos da documentação de produtos e criação de portal de conhecimento. Tem muitas funcionalidades incorporadas que tornam a criação, publicação, manutenção e gestão de projectos de criação de documentação de produtos realmente simples e divertidos! Aqui estão apenas algumas das muitas funcionalidades do nosso Docsie que o podem ajudar a atingir estes objectivos:
Ability to edit: Docsie permite a todos os nossos utilizadores editar a documentação do produto após a sua publicação, criando uma versão alternativa que só entrará em funcionamento quando estiver activa. Isto é fantástico porque as equipas de gestão do produto podem trabalhar na edição e alteração da documentação do produto e depois torná-la em directo assim que estiverem prontas para o fazer, sem saltar através de HTML, e CSS hoops. A documentação do produto será automaticamente apresentada numa troca de um nobre quando estiverem prontos.
Possibilidade de pesquisa: se a documentação do seu produto for abundante ou houver muitas características, os anúncios de plugins de pesquisa de documentos são um bónus útil que permite aos seus clientes pesquisar através da sua documentação de forma rápida e fácil para encontrar a informação de que necessitam para acelerar o processo no qual estão a visualizar e a absorver a informação da documentação do seu produto.
Possibilidade de ligação: Docsie torna a documentação do seu produto SEO amigável. Pode voltar a ligar a certas páginas do website da sua empresa ou apenas escrever palavras-chave com base nos seus produtos que serão pesquisáveis online e atraem novos clientes que procuram encontrar o mesmo produto que tem no lugar.
Possibilidade de ter diferentes traduções: O tradutor-fantasma de última geração permite aos nossos utilizadores traduzir a documentação dos seus produtos para várias línguas. Além disso, com as características do Docsie's language picker, os seus clientes podem escolher a língua que melhor lhes convier. Isto é altamente útil para o alcance global e para expandir a base de clientes das empresas, ao mesmo tempo que constrói confiança com os seus clientes recém-fundados e clientes no estrangeiro.
Possibilidade de atribuir tarefas e comentários para uma colaboração sem descontinuidades: Docsie tem ferramentas incríveis para colaborar com a sua equipa de documentação de produtos. Pode atribuir comentários, definir tarefas e atribuir papéis para que possa gerir melhor que tarefas são realizadas por que utilizador que está a trabalhar no seu projecto de documentação de produto com Docsie. Para saber mais consulte este blogue aqui.
Geração de alimentação: Ser capaz de saber o que os seus clientes estão a pensar sobre a sua documentação é a única forma de saber como optimizar a documentação do seu produto para corresponder às necessidades dos seus clientes, para que possam mo9recompreender de forma agradável a documentação do seu produto e portais de conhecimento Para saber mais sobre a importância do feedback da documentação do produto, consulte o meu blog aqui.
Há também muitas outras características e capacidades que Docsie lhe permite, a si e à sua equipa de gestão de produtos, utilizar para elaborar documentação de produtos espantosos. Neste artigo gostaria de saltar para plugins que cada portal de conhecimento Docsie e documentação de produto pode acrescentar às suas documentações para as melhorar e melhorar a sua sobre-utilização.
Docsie plugins para tornar o seu portal de Documentação dinâmico! Docsie tem um monte de plugins que pode utilizar para tornar a sua documentação mais apelativa. Neste blogue 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: A primeira parte mostraremos o que mostraremos o que mostraremos o 'Escolhedor da Versão de Exibição', 'Escolhedor da Versão de Exibição', as 'Âncoras da Secção de Exibição', e a 'Navegação do Rodapé de Exibição
PARTE 2: Nesta parte mostraremos o plugin 'Code Highlighting', 'Search' e 'Share to Social Network'.
PARTE 3: Na terceira parte mostraremos o 'Image Preview, 'Document Metadata', e o plugin 'Auto-highlight Section'.
Antes de saltarmos para os 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 assim que criarmos um novo Deployment através de 'Configure a new deployment+'.
Depois clique em 'Mais opções' que lhe permitirão adicionar estes plugins à sua documentação de Implantação através de um script embutido ou através do portal Docsie
A outra opção é aceder aos plugins de conhecimento da Docsie através do botão 'Update deployment configuration' abaixo da sua documentação já publicada.
Irá abrir este painel de instrumentos e depois poderá adicionar ou retirar plugins como achar conveniente e depois actualizar a instalação.
PARTE 1:
Agora que sabemos como aceder ao Docsie Pluggin, vamos saltar para PART 1*.
A fim de ver parte 1 video tutorial por favor veja este vídeo aqui:
vamos começar com o 'Mostrar versão Picker', e com o 'Mostrar Língua Picker'.
Uma vez activos, estes dois aparecerão na parte inferior esquerda do seu portal de conhecimentos como separadores flutuantes. Permitem aos seus clientes e aos que lêem a documentação do seu produto visualizar os documentos do seu produto em diferentes línguas e versões.
Uma vez que o utilizador prima a Língua dentro do colector de línguas, alterará toda a sua documentação que está a ler para aquela língua atribuída.
A âncora da Secção de Visualização uma vez activada permite que o seu cliente tenha ligações ao lado de cada cabeçalho, o que lhe dará ligações a certas secções da documentação.
Cada vez que estas ligações são premidas, à parte do cabeçalho, mudam e quando o seu cliente copia e cola este html, ele direcciona a pessoa para quem o envia, para esta secção específica da documentação.
A seguir é 'Mostrar Navegação com Rodapé'.
Este plugin adiciona um botão de navegação no canto inferior direito do seu Livro de documentação. Parece algo parecido com isto.
Desta forma, os seus clientes podem navegar mais confortavelmente através da sua documentação.
PARTE 2:
Para ver Parte 2 video tutorial por favor veja este vídeo aqui:
Nesta parte mostraremos o plugin 'Code Highlighting', 'Search' e 'Share to Social Network'.
Agora vamos começar com o plugin 'Code Highlighting'.
Este plugin é óptimo para produtos técnicos que necessitam de expressar vários códigos aos seus clientes. Este plugin permite aos seus clientes copiar e colar o código atribuído, para que possam utilizá-lo no seu editor para facilitar a sua utilização, adicionando um botão "Copiar".
Agora vamos mergulhar no plugin de pesquisa.
Uma vez activado no portal de conhecimento do seu Docsie, os seus clientes podem pesquisar a sua documentação através de uma navegação de pesquisa no canto superior direito do portal de conhecimento.
Ao clicarem em pesquisar, isto irá sustentar um painel de instrumentos sofisticado que permitirá aos seus clientes localizar exactamente onde encontrar certas informações dentro do seu arquivador e livros.
Isto acelera muito o processo no qual os seus clientes podem encontrar e recuperar a informação bem necessária sobre os seus produtos.
A seguir é o plugin Share To Social Networks
Este plugin permite aos seus clientes agarrar secções destacadas da documentação escrita do seu produto e partilhá-la nas suas redes sociais.
Isto é óptimo porque pode aumentar o tráfego, novos clientes potenciais e, sobretudo, a confiança da sua marca.
PARTE 3:
A fim de ver parte 3 video tutorial por favor veja este vídeo aqui:
Na terceira parte mostraremos o 'Image Preview, 'Document Metadata', e o plugin 'Auto-highlight Section'.
Vamos começar com o Plugin de Pré-visualização de Imagem
A pré-visualização da imagem permite aos seus clientes aumentar ou diminuir o zoom de uma imagem da documentação do seu produto a fim de a visualizar melhor.
A seguir, 'metadados de documentação'.
isto permite aos nossos clientes ver um carimbo de data/hora quando a documentação do produto ou aspectos do portal do conhecimento tiver sido actualizada. Este será localizado na parte superior e inferior da documentação escrita.
Agora vejamos o 'Plugin da Secção de Iluminação Automática
Este plugin simples permite aos seus clientes localizarem onde se encontram numa determinada documentação dentro do portal de conhecimento.
Destacará cada local onde se encontram, dentro do portal do Conhecimento, para que os clientes yo8ru possam acompanhar melhor que secção são, e navegar mais facilmente para outras secções.
Todas estas ferramentas e mais são-lhe fornecidas pela plataforma Docsie's. Se ainda não o experimentou, sugerimos que o faça. Clique aqui
Se tiver alguma questão, por favor contacte-nos em hello@docsie.io