DocumentaĆ§Ć£o
Para que vocĆŖ possa escrever ou alterar algum tipo de documento, Ć© essencial que conheƧa o seu conceito, o tipo de conteĆŗdo que ele aborda e o pĆŗblico-alvo ao qual se destina.
Manuais
O manual Ć© um documento que apoia o usuĆ”rio na instalaĆ§Ć£o, configuraĆ§Ć£o, integraĆ§Ć£o e utilizaĆ§Ć£o do sistema e suas funcionalidades, servindo como suporte durante todo o perĆodo de utilizaĆ§Ć£o do sistema.
Tipo
DescriĆ§Ć£o
PĆŗblico-alvo
Manual Conceitual
| TambĆ©m chamado de VisĆ£o geral ou Comece aqui. Explica o conceito de negĆ³cio do sistema e sua operaĆ§Ć£o de forma mais abrangente, trazendo informaƧƵes sobre fluxos e dores do pĆŗblico-alvo que a soluĆ§Ć£o foi pensada para resolver. | Este manual se destina ao usuĆ”rio que nĆ£o conhece o produto, a fim de se inteirar das regras de negĆ³cio. |
Manual de UsuƔrio
| TambĆ©m chamado de Usando o (PRODUTO). Apresenta o passo a passo de como utilizar o sistema. Ć um tutorial que ensina o usuĆ”rio a navegar pelo software e executar suas aƧƵes. | Este manual se destina a usuĆ”rios que utilizam as funcionalidades do sistema. |
Manual de AdministraĆ§Ć£o
| TambƩm chamado de Usando o (PRODUTO). Pretende auxiliar o usuƔrio com informaƧƵes e requisitos para instalar, configurar e administrar o produto. | Este manual se destina a administradores que possuem conhecimentos tƩcnicos do produto. |
Manual de IntegraĆ§Ć£o | Esse documento contempla as orientaƧƵes para realizar a integraĆ§Ć£o de sistemas externos com as APIās dos nossos produtos. | Este manual se destina aos desenvolvedores e/ou usuĆ”rios que realizam as integraƧƵes dos sistemas. |
Release Notes
O Release note Ć© um documento simples cujo objetivo Ć© comunicar as atualizaƧƵes implementadas em uma versĆ£o do sistema.
Pode ser dividido em quatro tĆ³picos:
Novas funcionalidades
CorreƧƵes
Melhorias
HomologaƧƵes
Tipo
DescriĆ§Ć£o
PĆŗblico-alvo
Novas funcionalidades
| O conteĆŗdo deve ser escrito levando informaƧƵes sobre quais foram as novidades inseridas no produto. Cada uma delas deve informar quais vantagens ou ganhos ela representa, de que forma trarĆ” mais agilidade ou seguranƧa ao sistema, como facilita a rotina do usuĆ”rio e principalmente do que se trata esta nova funcionalidade e onde/como ela Ć© encontrada para ser utilizada. | O Release terĆ” sempre o pĆŗblico-alvo que utiliza nosso produto, sendo ele administrador ou usuĆ”rio. |
CorreƧƵes | Leva ao usuĆ”rio informaƧƵes sobre todas as correƧƵes que a versĆ£o contempla, deixando claro o que estava acontecendo e qual foi a soluĆ§Ć£o aplicada para corrigir a inconsistĆŖncia do produto. | |
Melhorias | Leva ao usuĆ”rio informaƧƵes sobre todas as melhorias que a versĆ£o contempla. Estas melhorias sĆ£o geralmente baseadas em uma inconsistĆŖncia do sistema, mas que alĆ©m de ser corrigida apresenta tambĆ©m um ganho significativo para o usuĆ”rio ou para o produto. | |
HomologaƧƵes | Este item Ć© especĆfico de alguns produtos, que contĆ©m a informaĆ§Ć£o sobre equipamentos ou sistemas que o produto passou a ser compatĆvel. |
Base de Conhecimento
Podemos definir a base de conhecimento como uma espĆ©cie de biblioteca online, construĆda para solucionar problemas e sanar dĆŗvidas recorrentes. Nela, hĆ” diversos materiais sobre o uso de um produto ou funcionalidade.
Bases de conhecimento internas
Uma base de conhecimento interna, como o nome sugere, Ć© um banco de informaƧƵes privadas de uma empresa, sendo geralmente construĆdo com base em aprendizagem.
Embora essa base de conhecimento possa ser usada para diferentes fins, como onboarding de funcionĆ”rios ou para o atendimento ao cliente, elas sĆ£o Ćŗteis para chamados do suporte e autoatendimento.
Bases de conhecimento externas
Enquanto uma base de conhecimento interna tem a prioridade de ajudar a empresa e seus funcionƔrios, uma base de conhecimento externa Ʃ geralmente voltada para os usuƔrios do produto.
Como as bases de conhecimento externas sĆ£o para clientes atuais ou clientes em potencial, o conteĆŗdo inserido nelas Ć© muito diferente do conteĆŗdo de bases de conhecimento internas; aqui entram fatores como leitura, conveniĆŖncia e atĆ© mesmo entretenimento.
Artigos
As bases de conhecimento podem ter diferentes tipos de conteĆŗdo, mas os artigos sĆ£o, em sua maioria, uma parte essencial de qualquer base de conhecimento.
Isso porque eles sĆ£o consenso em termos de conteĆŗdo didĆ”tico, portanto devem ser a primeira coisa a ser inserida na base de conhecimento.
E como estes artigos sĆ£o divididos?
Tipo
DescriĆ§Ć£o
PĆŗblico-alvo
FAQ
| Uma FAQ Ć© um documento, geralmente construĆdo no formato de perguntas e respostas, contendo as dĆŗvidas recorrentes sobre um determinado assunto. | UsuĆ”rios que conhecem brevemente as regras de negĆ³cio, que utilizam ou nĆ£o o sistema. |
SoluĆ§Ć£o de problemas
| Auxilia o usuĆ”rio na realizaĆ§Ć£o de procedimentos que solucionam problemas para utilizaĆ§Ć£o da nossa soluĆ§Ć£o. | UsuĆ”rios ou administradores do produto. |
Tutoriais | Artigos de tutoriais (how to) orientam o usuĆ”rio a realizar procedimentos de instalaƧƵes ou configuraƧƵes para utilizaĆ§Ć£o dos produtos e funcionalidades da NDD. | UsuĆ”rios ou administradores do produto. |