Mudanças entre as edições de "Como documentar"
(→Telas / Campos) |
|||
| (8 revisões intermediárias por 2 usuários não estão sendo mostradas) | |||
| Linha 1: | Linha 1: | ||
| − | =='''Conceito'''== | + | ==='''Conceito'''=== |
Aqui passamos a forma de montar as novas documentações do Sistema, seja na modalidade de HELP ou documentação técnica interna. | Aqui passamos a forma de montar as novas documentações do Sistema, seja na modalidade de HELP ou documentação técnica interna. | ||
| − | ==''Forma de fazer''== | + | ==='''O que é'''=== |
| + | Nesta caso devemos dizer para que serve a funcionalidade, mesmo parecendo "obvio" devemos registar o que é o processo ou rotina. | ||
| + | |||
| + | ==='''Forma de fazer'''=== | ||
Quando formos montar uma documentação devemos considerar alguns tópicos, como os citados abaixo: | Quando formos montar uma documentação devemos considerar alguns tópicos, como os citados abaixo: | ||
| − | = | + | ==='''Para que serve'''=== |
| − | |||
| − | |||
| − | =='''Para que serve'''== | ||
Quando entendemos a funcionalidade do processo, muitas vezes conseguimos tomar ações baseadas neste entendimento. | Quando entendemos a funcionalidade do processo, muitas vezes conseguimos tomar ações baseadas neste entendimento. | ||
| − | =='''Quais os benefícios e/ou ganhos de uso'''== | + | ==='''Quais os benefícios e/ou ganhos de uso'''=== |
Muitas vezes os usuários do sistema, não realizam processos, por não entender os impactos e resolver fazer somente uma parte do processo, ou muitas vezes pula etapas, com isso perdendo registros preciosos que poderiam ser usados em analises futuras. | Muitas vezes os usuários do sistema, não realizam processos, por não entender os impactos e resolver fazer somente uma parte do processo, ou muitas vezes pula etapas, com isso perdendo registros preciosos que poderiam ser usados em analises futuras. | ||
| − | =='''Exemplos'''== | + | ==='''Exemplos'''=== |
Sempre que possível, devemos citar um exemplo, procurando ao máximo ser Atemporal, ou seja, qualificar algo para não ser afetado pelo passar do tempo, ou seja, que faz parte de qualquer época ou tempo. ''Exemplo - usar datas - leis.'' | Sempre que possível, devemos citar um exemplo, procurando ao máximo ser Atemporal, ou seja, qualificar algo para não ser afetado pelo passar do tempo, ou seja, que faz parte de qualquer época ou tempo. ''Exemplo - usar datas - leis.'' | ||
| − | ==''' | + | ==='''Campos'''=== |
Seguindo o mesma lógica dos itens acima, sempre é recomendável fazer a citação do campo e qual a sua necessidade. | Seguindo o mesma lógica dos itens acima, sempre é recomendável fazer a citação do campo e qual a sua necessidade. | ||
| − | |||
''Por padrão não adicionamos Imagens/figuras ao processo de documentação'' | ''Por padrão não adicionamos Imagens/figuras ao processo de documentação'' | ||
| − | =='''Conclusão'''== | + | ==='''Conclusão'''=== |
Casou houver possibilidade, ao final da documentação se faz necessário realizar uma pequena conclusão, seja ela apontando outras leituras seja ela encerrando o entendimento do processo tela. | Casou houver possibilidade, ao final da documentação se faz necessário realizar uma pequena conclusão, seja ela apontando outras leituras seja ela encerrando o entendimento do processo tela. | ||
| − | ==''' | + | ==='''Sugestão de Leitura'''=== |
Da mesma forma que a conclusão, sempre que possível recomendar outras leituras através de link das outras paginas da WIKI. | Da mesma forma que a conclusão, sempre que possível recomendar outras leituras através de link das outras paginas da WIKI. | ||
| + | |||
| + | |||
| + | ---- | ||
| + | |||
| + | |||
| + | '''Assuntos Relacionados''' | ||
| + | |||
| + | [[Pedido de Venda Futura|Venda Futura]] | ||
Edição atual tal como às 09h55min de 12 de junho de 2023
Índice
Conceito
Aqui passamos a forma de montar as novas documentações do Sistema, seja na modalidade de HELP ou documentação técnica interna.
O que é
Nesta caso devemos dizer para que serve a funcionalidade, mesmo parecendo "obvio" devemos registar o que é o processo ou rotina.
Forma de fazer
Quando formos montar uma documentação devemos considerar alguns tópicos, como os citados abaixo:
Para que serve
Quando entendemos a funcionalidade do processo, muitas vezes conseguimos tomar ações baseadas neste entendimento.
Quais os benefícios e/ou ganhos de uso
Muitas vezes os usuários do sistema, não realizam processos, por não entender os impactos e resolver fazer somente uma parte do processo, ou muitas vezes pula etapas, com isso perdendo registros preciosos que poderiam ser usados em analises futuras.
Exemplos
Sempre que possível, devemos citar um exemplo, procurando ao máximo ser Atemporal, ou seja, qualificar algo para não ser afetado pelo passar do tempo, ou seja, que faz parte de qualquer época ou tempo. Exemplo - usar datas - leis.
Campos
Seguindo o mesma lógica dos itens acima, sempre é recomendável fazer a citação do campo e qual a sua necessidade.
Por padrão não adicionamos Imagens/figuras ao processo de documentação
Conclusão
Casou houver possibilidade, ao final da documentação se faz necessário realizar uma pequena conclusão, seja ela apontando outras leituras seja ela encerrando o entendimento do processo tela.
Sugestão de Leitura
Da mesma forma que a conclusão, sempre que possível recomendar outras leituras através de link das outras paginas da WIKI.
Assuntos Relacionados
