Para iniciar a documentação, é necessário ter em mente algumas informações: É preciso entender o objetivo e justificativa da documentação, para que a documentação faça sentido enquanto estiver sendo construída e não desvie do foco que esta tem.
Para começar, é importante saber e entender o Objetivo e a Justificativa da documentação:
Objetivo: Qual é o objetivo da documentação?
O objetivo da documentação é fazer com que o usuário entenda as funcionalidades do sistema com facilidade. Com isso, o índice de dúvidas e erros operacionais tende a diminuir com o acesso facilitado às informações.
Para que a documentação seja compreendida por pessoas de vários níveis de usabilidade do sistema (iniciante, intermediário e avançado), é necessário utilizar uma linguagem simples, direta e assertiva, porém, rica em informações. Desta forma, até mesmo os usuários mais inexperientes no sistema entenderão como funcionam os processos somente vendo as instruções na documentação, tornando-se mais independentes e capacitados para operar o sistema com tranquilidade, além de estarem cientes das funcionalidades que existem no sistema. Além de claro, auxiliar os colaboradores da Edusoft em sanar suas dúvidas sobre as funcionalidades existentes no sistema.
Justificativa: Qual a justificativa de termos uma documentação?
A justificativa para termos uma documentação é fazer com que cada vez mais os clientes da Edusoft estejam seguros no momento de operar o sistema, tornando-se independentes e munidos de informações precisas e atualizadas do sistema.
Após entender o Objetivo e Justificativa da documentação, é importante realizar alguns procedimentos antes de começar a documentar. Abaixo, seguem as orientações a respeito desses procedimentos, bem como, as instruções de documentação. Clique nas abas para saber mais.