Documentação
- Paulo Henrique Paixão
- Catarine Maltauro da Silva
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. |