Mudanças entre as edições de "Como documentar"
(→O que é) |
|||
| Linha 1: | Linha 1: | ||
==='''Conceito'''=== | ==='''Conceito'''=== | ||
| − | Aqui | + | Aqui definimos a forma de elaborar as novas documentações do sistema, seja na modalidade de HELP ou na documentação técnica interna. |
==='''O que é'''=== | ==='''O que é'''=== | ||
| − | + | Neste tópico, devemos descrever para que serve a funcionalidade. Mesmo que pareça “óbvio” na maioria dos casos, é importante registrar o que é o processo ou rotina, caso isso não esteja claro no conceito. | |
==='''Forma de fazer'''=== | ==='''Forma de fazer'''=== | ||
| − | + | Ao montar uma documentação, devemos considerar alguns tópicos, como os citados abaixo: | |
| − | |||
==='''Para que serve'''=== | ==='''Para que serve'''=== | ||
| − | Quando | + | Quando compreendemos a funcionalidade do processo, conseguimos tomar decisões e executar ações com base nesse entendimento. |
==='''Quais os benefícios e/ou ganhos de uso'''=== | ==='''Quais os benefícios e/ou ganhos de uso'''=== | ||
| − | Muitas vezes os usuários | + | Muitas vezes, os usuários deixam de executar processos por não compreenderem seus impactos, realizando apenas parte das etapas ou até mesmo ignorando algumas delas. Com isso, perdem-se registros importantes que poderiam ser utilizados em análises futuras. |
==='''Exemplos'''=== | ==='''Exemplos'''=== | ||
| − | Sempre que possível, devemos citar | + | Sempre que possível, devemos citar exemplos, buscando ao máximo que sejam atemporais, ou seja, que não sejam afetados pelo passar do tempo. |
| + | ''Exemplo: evitar uso de datas ou leis específicas.'' | ||
==='''Cadastro'''=== | ==='''Cadastro'''=== | ||
| − | Seguindo | + | Seguindo a mesma lógica dos itens acima, é recomendável descrever cada campo e sua respectiva finalidade. |
| − | ''Por padrão não adicionamos | + | ''Por padrão, não adicionamos imagens/figuras ao processo de documentação.'' |
==='''Conclusão'''=== | ==='''Conclusão'''=== | ||
| − | + | Caso haja possibilidade, ao final da documentação é recomendável incluir uma breve conclusão, seja apontando outras leituras, seja encerrando o entendimento do processo ou da tela. | |
==='''Sugestão de Leitura'''=== | ==='''Sugestão de Leitura'''=== | ||
| − | Da mesma forma que a conclusão, sempre que possível recomendar outras leituras | + | Da mesma forma que a conclusão, sempre que possível, recomendar outras leituras por meio de links para outras páginas da WIKI. |
| − | |||
| − | |||
| − | |||
| − | |||
'''Assuntos Relacionados''' | '''Assuntos Relacionados''' | ||
[[Pedido de Venda Futura|Venda Futura]] | [[Pedido de Venda Futura|Venda Futura]] | ||
Edição atual tal como às 16h48min de 7 de abril de 2026
Índice
Conceito
Aqui definimos a forma de elaborar as novas documentações do sistema, seja na modalidade de HELP ou na documentação técnica interna.
O que é
Neste tópico, devemos descrever para que serve a funcionalidade. Mesmo que pareça “óbvio” na maioria dos casos, é importante registrar o que é o processo ou rotina, caso isso não esteja claro no conceito.
Forma de fazer
Ao montar uma documentação, devemos considerar alguns tópicos, como os citados abaixo:
Para que serve
Quando compreendemos a funcionalidade do processo, conseguimos tomar decisões e executar ações com base nesse entendimento.
Quais os benefícios e/ou ganhos de uso
Muitas vezes, os usuários deixam de executar processos por não compreenderem seus impactos, realizando apenas parte das etapas ou até mesmo ignorando algumas delas. Com isso, perdem-se registros importantes que poderiam ser utilizados em análises futuras.
Exemplos
Sempre que possível, devemos citar exemplos, buscando ao máximo que sejam atemporais, ou seja, que não sejam afetados pelo passar do tempo. Exemplo: evitar uso de datas ou leis específicas.
Cadastro
Seguindo a mesma lógica dos itens acima, é recomendável descrever cada campo e sua respectiva finalidade.
Por padrão, não adicionamos imagens/figuras ao processo de documentação.
Conclusão
Caso haja possibilidade, ao final da documentação é recomendável incluir uma breve conclusão, seja apontando outras leituras, seja encerrando o entendimento do processo ou da tela.
Sugestão de Leitura
Da mesma forma que a conclusão, sempre que possível, recomendar outras leituras por meio de links para outras páginas da WIKI.
Assuntos Relacionados
