O grande diferencial do Maker é sem dúvidas o uso de fluxogramas como “código-fonte”. Mas esse grande diferencial só terá o seu real valor com uma boa documentação. Uma boa documentação de um fluxograma no Maker é aquela em que você consegue entender o que foi feito sem precisar abrir o objeto. É um detalhe simples que fará muita diferença em manutenções futuras no sistema.
Seguem algumas dicas para uma boa documentação de um fluxo
1 – Uso do objeto Comentário.
Este objeto não existe apenas para enfeite. Faça bom uso dele.
1.1 – Utilize-o para explicar a lógica usada na sua regra. Lembre-se que ninguém pensa igual, se a sua regra é complexa, utilize um objeto Comentário e explique resumidamente a lógica utilizada, assim quando outro desenvolvedor for dar manutenção no seu fluxograma ele conseguirá entender mais facilmente a lógica utilizada.
1.2 – Outro uso importante para este objeto é o detalhamento dos parâmetros de entrada e retornos do fluxo, usando um logo após o Início do fluxo explicando quais são os parâmetros de entrada e outro antes do Fim, detalhando o que é retornado.
1.3 – O Comentário também pode ser usado nas saídas de decisões para informar a ação a ser executada após o resultado daquela decisão.
2 – Documentando um objeto Processamento.
Não devem ser poupadas informações. Mas também não precisa escrever um livro dentro de um processamento, seja simples, mas completo. Seu processamento abre uma consulta em uma tabela? Não escreva simplesmente “Abrir Consulta”. Detalhe o processo, informe em qual tabela está sendo feita a consulta, qual o filtro usado nela. Está enviando um email? Não escreva simplesmente “Enviar Email”, informe qual será o destinatário, qual o objetivo do envio daquele email.
2 –Documentando um objeto Decisão.
Toda decisão é um questionamento, lembre-se disso quando for documentar este objeto. Escreva perguntas.
3 – Documentando um objeto Interação.
A interação é usada na maioria das vezes para exibição de mensagens de alerta ou de erro para o usuário. Comece escrevendo qual o tipo de mensagem usado, depois a própria mensagem.
4 – Nomes de variáveis.
O Maker não tem uma sintaxe obrigatória para a definição de variáveis, então faça proveito disso e deixe-as bem legíveis.
5 – Salvando um fluxo.
5.1 – Utilize o espaço “Descrição” das propriedades do fluxo (menu Arquivo -> Propriedades ou CTRL + P) para informar o objetivo do fluxo. A diferença será percebida ao associar o fluxo a um evento, ou chama-lo como Subfluxo, pois a descrição da regra será mostrada, da mesma forma como uma função nativa do Maker.
5.2 – Separe os fluxos por categorias e informe qual o formulário onde ele será usado. Caso seja um sistema grande, separado em módulos, informe a qual módulo a regra pertence. Isso facilitará na pesquisa do fluxo.
6 – Organizando o fluxograma.
Mantenha o fluxo organizado, linhas retas, objetos alinhados e com tamanhos relativos às suas descrições. Um macete bastante útil é usar um objeto Comentário bem pequeno para melhorar o aspecto visual.
Seguindo essas dicas a documentação do seu fluxograma ficará muito mais organizada e completa. A equipe ganhará mais tempo na manutenção, até mesmo o próprio desenvolvedor do fluxograma será favorecido, quando precisar dar manutenção daqui a alguns dias, meses ou anos.
Lembre-se: o fluxograma não está ali apenas para você “programar”. Ele é muito mais que isso. Ele é o seu diferencial com o Maker. Ele é a aproximação do desenvolvedor com o cliente, com o usuário final. Ele é a documentação do seu software que será entregue ao seu cliente, já que funcionalidade de documentação automática do Maker gera imagens de todos os fluxos presentes no sistema. Já teve a experiência de entregar a um cliente a documentação de um sistema gerada pela documentação automática do Maker, com os fluxos todos bem limpos, organizados, com uma documentação satisfatória? Pense nisso quando for desenvolver um fluxograma a partir de agora.
Documentando Fluxogramas
O grande diferencial do Maker é sem dúvidas o uso de fluxogramas como “código-fonte”. Mas esse grande diferencial só terá o seu real valor com uma boa documentação. Uma boa documentação de um fluxograma no Maker é aquela em que você consegue entender o que foi feito sem precisar abrir o objeto. É um detalhe simples que fará muita diferença em manutenções futuras no sistema.
Seguem algumas dicas para uma boa documentação de um fluxo
1 – Uso do objeto Comentário.
Este objeto não existe apenas para enfeite. Faça bom uso dele.
1.1 – Utilize-o para explicar a lógica usada na sua regra. Lembre-se que ninguém pensa igual, se a sua regra é complexa, utilize um objeto Comentário e explique resumidamente a lógica utilizada, assim quando outro desenvolvedor for dar manutenção no seu fluxograma ele conseguirá entender mais facilmente a lógica utilizada.
1.2 – Outro uso importante para este objeto é o detalhamento dos parâmetros de entrada e retornos do fluxo, usando um logo após o Início do fluxo explicando quais são os parâmetros de entrada e outro antes do Fim, detalhando o que é retornado.
1.3 – O Comentário também pode ser usado nas saídas de decisões para informar a ação a ser executada após o resultado daquela decisão.
2 – Documentando um objeto Processamento.
Não devem ser poupadas informações. Mas também não precisa escrever um livro dentro de um processamento, seja simples, mas completo. Seu processamento abre uma consulta em uma tabela? Não escreva simplesmente “Abrir Consulta”. Detalhe o processo, informe em qual tabela está sendo feita a consulta, qual o filtro usado nela. Está enviando um email? Não escreva simplesmente “Enviar Email”, informe qual será o destinatário, qual o objetivo do envio daquele email.
2 –Documentando um objeto Decisão.
Toda decisão é um questionamento, lembre-se disso quando for documentar este objeto. Escreva perguntas.
3 – Documentando um objeto Interação.
A interação é usada na maioria das vezes para exibição de mensagens de alerta ou de erro para o usuário. Comece escrevendo qual o tipo de mensagem usado, depois a própria mensagem.
4 – Nomes de variáveis.
O Maker não tem uma sintaxe obrigatória para a definição de variáveis, então faça proveito disso e deixe-as bem legíveis.
5 – Salvando um fluxo.
5.1 – Utilize o espaço “Descrição” das propriedades do fluxo (menu Arquivo -> Propriedades ou CTRL + P) para informar o objetivo do fluxo. A diferença será percebida ao associar o fluxo a um evento, ou chama-lo como Subfluxo, pois a descrição da regra será mostrada, da mesma forma como uma função nativa do Maker.
5.2 – Separe os fluxos por categorias e informe qual o formulário onde ele será usado. Caso seja um sistema grande, separado em módulos, informe a qual módulo a regra pertence. Isso facilitará na pesquisa do fluxo.
6 – Organizando o fluxograma.
Mantenha o fluxo organizado, linhas retas, objetos alinhados e com tamanhos relativos às suas descrições. Um macete bastante útil é usar um objeto Comentário bem pequeno para melhorar o aspecto visual.
Seguindo essas dicas a documentação do seu fluxograma ficará muito mais organizada e completa. A equipe ganhará mais tempo na manutenção, até mesmo o próprio desenvolvedor do fluxograma será favorecido, quando precisar dar manutenção daqui a alguns dias, meses ou anos.
Lembre-se: o fluxograma não está ali apenas para você “programar”. Ele é muito mais que isso. Ele é o seu diferencial com o Maker. Ele é a aproximação do desenvolvedor com o cliente, com o usuário final. Ele é a documentação do seu software que será entregue ao seu cliente, já que funcionalidade de documentação automática do Maker gera imagens de todos os fluxos presentes no sistema. Já teve a experiência de entregar a um cliente a documentação de um sistema gerada pela documentação automática do Maker, com os fluxos todos bem limpos, organizados, com uma documentação satisfatória? Pense nisso quando for desenvolver um fluxograma a partir de agora.