Publicação de documentação de produto com Docsie

Avatar of Author
Tal F.
on June 30, 2021 · · filed under Product Documentation AI Product Management Documentation Portals Technical Writing

Olá a todos!

No meu último vídeo falei sobre como criar documentação de produtos e editar a documentação do vosso produto. Também lhe mostrei como incorporar vídeos, imagens, meios de comunicação, bem como código para que possa criar documentação de produtos para que possa educar ainda mais os seus clientes sobre as suas plataformas e soluções técnicas.

Agora queria dar um mergulho profundo na plataforma de documentação de produtos Docsie e mostrar-vos como criar documentação de software simples e fácil.

Aqui está um tutorial rápido sobre como explicar como publicar com Docsie.

A publicação com o portal do conhecimento da Docsie pode ser feita de algumas maneiras. Neste vídeo explico como publicar com Docsie's knowledge portals, livros, prateleiras ou artigos com uma simples linha de código.

Neste exemplo quis publicar este livro específico chamado 'Writing your first Django app, parte 2'.

Como podem ver na minha actual documentação de software já criada, escrevi uma versão chamada 'Brand new portal that I am working on' e se clicarem na ferramenta 'lápis' perto dela têm a opção de tornar o vosso portal publicado 'activo' ou 'primário' ou desligar estas funcionalidades. o que é fantástico porque isso significa que vocês e a vossa equipa podem escrever ou actualizar a vossa documentação e não a ter visível para os vossos clientes ou clientes até estarem prontos para a ter publicada a vossa documentação de produto criada em produção no vosso website:

Que estou pronto para publicar o seu tempo de distribuição da sua documentação! Isto é feito facilmente, clicando primeiro nos três pontos no canto superior direito da plataforma Docsie, e depois clicando na sua conta:

Quando estiver na sua página de Perfil e configurações, clique no separador intitulado "Implantação". isto irá levá-lo para a página de implantação e ajudá-lo-á a configurar-se na criação do seu código de incorporação que será colocado no seu website.

Agora clique em "Configurar uma nova implantação +".

Óptimo! Agora que tem acesso ao painel de instrumentos, tudo o que precisa de fazer é implementar um domínio personalizado, isto é feito facilmente abrindo a "Implementação de um domínio: barra de tabulação e clicando em 'implementação personalizada'.

Agora os dois passos seguintes são simples:

  1. O primeiro passo é escrever no seu domínio (e lembre-se de utilizar http:// ou https:// antes de escrever o seu nome de domínio)

  2. o segundo passo é escolher o que quer publicar, tem a opção de publicar, um Livro ou uma Prateleira inteira. Neste exemplo, estou a publicar um livro: "Escrevendo a sua primeira aplicação Django, parte 2".

Óptimo! Agora o último passo é antes de obter o nosso código, clicar em "+Mais Opções".

Agora pode utilizar os nossos vários plugins, características e outras opções de documentação para apimentar o seu portal de conhecimentos e torná-lo mais prático para os seus utilizadores. Estas características, plugins e ferramentas de documentação de produtos são bastante sofisticadas e tornam os seus portais de conhecimento mais robustos.

nota: pode alterar estas características adicionais e plugins e outras ferramentas de documentação de produtos em qualquer altura.

Uma vez feito isso, clicar em 'Criar portal web'.

Agora desça até ao fundo e clique em "+ Obter script de implementação".

E copie o seu guião e cole-o no seu HTML:

Agora que tem acesso ao seu guião pode apimentar as coisas com o nosso guia de utilizador CSS, ele ajudá-lo-á a criar um elegante portal de conhecimento Docsie que combina com a aparência e a sensação das suas marcas. Por favor, reveja aqui o nosso guia do utilizador de estilo neste link: Guia de Estilismo Docsie

Espero que tenha gostado deste tutorial, por favor fique atento a mais tutoriais Docsie num futuro próximo!

Se tiver alguma questão sobre como Docsie pode ajudar e quiser que lhe mostremos uma demonstração das nossas ferramentas por favor sinta-se à vontade para Clique Aqui para reservar uma demonstração connosco.


Subscribe to the newsletter

Stay up to date with our latest news and products