Como documentar - Histórico de revisão

Admin em 19h48min de 7 de abril de 2026

2026-04-07T19:48:59Z

Admin: /* O que é */

2025-05-29T17:40:06Z

‎O que é

Admin: /* Campos */

2025-03-13T10:44:38Z

‎Campos

Admin em 12h55min de 12 de junho de 2023

2023-06-12T12:55:21Z

Admin em 22h27min de 25 de fevereiro de 2023

2023-02-25T22:27:47Z

Admin em 16h29min de 3 de fevereiro de 2023

2023-02-03T16:29:00Z

Admin: /* Quais os benefícios e/ou ganhos de uso */

2023-01-14T14:51:44Z

‎Quais os benefícios e/ou ganhos de uso

Admin em 14h51min de 14 de janeiro de 2023

2023-01-14T14:51:35Z

Admin em 14h51min de 14 de janeiro de 2023

2023-01-14T14:51:01Z

Admin em 14h50min de 14 de janeiro de 2023

2023-01-14T14:50:28Z

@@ Linha 1: / Linha 1: @@
 ==='''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 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 é'''===
-Nesta caso devemos dizer para que serve a funcionalidade, mesmo parecendo "obvio" na maioria dos casos, podemos registar o que é o processo ou rotina se não estiver transparente no conceito.
+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 entendemos a funcionalidade do processo, muitas vezes conseguimos tomar ações baseadas neste entendimento.
+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 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 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 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 exemplos, buscando ao máximo que sejam atemporais, ou seja, que não sejam afetados pelo passar do tempo.
 ==='''Cadastro'''===
-Seguindo o mesma lógica dos itens acima, sempre é recomendável fazer a citação do campo e qual a sua necessidade.
+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''
+''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.
+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 através de link das outras paginas da WIKI.
+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'''
 [[Pedido de Venda Futura|Venda Futura]]

@@ Linha 4: / Linha 4: @@
 ==='''O que é'''===
-Nesta caso devemos dizer para que serve a funcionalidade, mesmo parecendo "obvio" devemos registar o que é o processo ou rotina.
+Nesta caso devemos dizer para que serve a funcionalidade, mesmo parecendo "obvio" na maioria dos casos, podemos registar o que é o processo ou rotina se não estiver transparente no conceito.
 ==='''Forma de fazer'''===

@@ Linha 19: / Linha 19: @@
 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'''===
+==='''Cadastro'''===
 Seguindo o mesma lógica dos itens acima, sempre é recomendável fazer a citação do campo e qual a sua necessidade.

@@ Linha 19: / Linha 19: @@
 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.''
-==='''Telas / Campos'''===
+==='''Campos'''===
 Seguindo o mesma lógica dos itens acima, sempre é recomendável fazer a citação do campo e qual a sua necessidade.

← Edição anterior		Edição das 22h27min de 25 de fevereiro de 2023
Linha 29:		Linha 29:
	==='''Sugestão de Leitura'''===		==='''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]]