Padrão SuperSoft de Fluxogramas

Neste livro se encontram todas as informações referentes à construção de fluxogramas, desde a ferramenta utilizada, componentes e seus respectivos usos, notações comuns e boas práticas.

Ferramenta
Componentes
Importando Bibliotecas
Formatação Padrão
Hierarquia de Cores
Camadas
Estruturas

Ferramenta

Os fluxogramas elaborados para a documentação dos processos internos e processos dos sistemas serão construídos com a ferramenta Draw.io, podendo ser acessada diretamente pelo navegador através deste link ou através da aplicação disponível para desktop (recomendado), onde o download das versões pode ser realizado neste link.

Esta ferramenta foi escolhida por ser uma ferramenta de fácil acesso, com uma ampla biblioteca de recursos e componentes, além de ser gratuita e permitir exportação dos grafos em diversos formatos. Tópicos estes, que serão abordados mais pra frente.

Componentes

Em anexo à essa página, se encontra um arquivo .xml com os componentes aqui citados, é recomendável que o importe como biblioteca para o seu draw.io. Isso irá facilitar a localização dos componentes corretos e com as configurações recomendadas. Caso você não saiba importar uma biblioteca de componentes, clique aqui.

Existem diversos componentes, das mais variadas bibliotecas e estilos. Por isso, vamos nos ater à alguns componentes primeiramente e conforme o uso de fluxogramas se torne comum e mais disseminado dentro da empresa, ampliaremos os componentes para que possam ilustrar fielmente os processos mapeados e suas etapas.

Importando Bibliotecas

Instruções

Para realizar a importação de uma biblioteca, basta acessar o seguinte menu:

Logo em seguida, será aberta uma janela para selecionar o arquivo que deseja importar. Basta navegar até o arquivo e clicar em abrir. (O formato utilizado para bibliotecas na ferramenta é o XML).

Feito isso, uma nova biblioteca é adicionada na barra esquerda do draw.io.

Formatação Padrão

Pré-requisitos:

Antes de começar a construir os fluxogramas, certifique-se de de ter lido as páginas de componentes e estruturas para lhe orientar e ajudar na construção de forma padronizada.

Cores

As cores utilizadas nos componentes ou no preenchimento dos quadros podem diferenciar dependendo da situação na qual o fluxograma está sendo criado, porém alguns padrões deve ser seguidos.

Cores dos componentes

Por padrão da ferramenta Draw.io, a cor dos componentes adicionados é branco, porem existe a possibilidade de serem alteradas, mas se não tiver algum motivo especifico para a alteração da cor, mantenha branco.

Cores de fundo

Por padrão a cor do fundo na construção do fluxograma também é branco, porém se for necessário submeter o fluxograma à algum processo que se repita ou algum processo assíncrono, essas situações citadas devem ser submetidas a um quadro que os envolva e indique estar relacionados ou separados de todo o processo e definir segundo a hierarquia de cores definida.

Cores das setas

As setas devem sempre ser utilizadas com a cor padrão preta, salvo exceções especificas que queiram demonstrar alguma correlação a algum processo ou componente, mas caso não tenha necessidade deixar tudo em preto.

Componentes

Ao longo da construção dos fluxogramas, diversos componentes serão utilizados, e para seguirmos um padrão algumas regras devem ser consideradas ao escolher o componente ou ao definir seu tamanho e posição.

Tamanho

Quando adicionado um novo componente ao fluxograma, a ferramenta já possui um tamanho padrão, então mantenha neste padrão, a menos que seja necessário aumentar seu tamanho devido ao texto contido dentro ou por qualquer outro motivo que seja válido.

Formatos

O formato padrão a ser utilizado é sempre com suas bordas quadradas, que é a maneira na qual a ferramenta já está configurada.

Espessura

A espessura geral dos componentes devem ser sempre 1 pt (unidade utilizada na ferramenta Draw.io), salvo para os componentes de terminação (início e fim) que devem possuir espessura de 2 pt.

Posicionamento

Não existe uma maneira correta de posicionar os componentes contidos no fluxograma, mas quanto mais organizado melhor o entendimento geral, então ao adicionar ou finalizar o processo de construção de seu fluxograma, organize seus componentes de forma que fique o mais fácil possível de ser visualizado e de forma a evitar o cruzamento de setas e componentes.

Quais utilizar

Quando estiver com dúvidas em qual componente utilizar, você pode consultar a página de componentes que mostra e detalha brevemente os componentes e suas funções no fluxograma. Caso na página não contenha o componente que precise, pode ser pesquisado na web e após fazer isso, sinta-se a vontade de adicionar este componente na página referente, para que futuramente alguém que venha a passar pela mesma situação, já encontre uma maior diversidade de componentes na página.

Linhas e setas

As setas são utilizadas para definir a direção do processo e também podem ser utilizadas como bidirecionais. Por padrão devem ser utilizadas na cor preta, salvo exceções especificas que surgirem.

Quais utilizar

Existem duas situações distintas para utilizar as setas:

As setas unidirecionais, que são utilizadas para indicar relação entre componentes e também o fluxo do processo.
As setas bidirecionais que são utilizada para indicar um fluxo de ida e volta, com por exemplo uma consulta no banco que retorna informações e essas informações são alteradas e enviadas novamente para serem salvas no banco de dados.

Conectores

Os conectores são de grande utilidade para linkar partes do fluxograma sem a necessidade de ficar cruzando linhas, então ao adicionar um conector, utilize a cor definida na hierarquia de cores e o tamanho já estabelecido, podendo variar em determinadas situações.

Qualquer dúvida referente a componentes podem ser esclarecidas na página componentes, lembrando que caso não contenha na página, algum desenvolvedor mais experiente pode ser acionado para ajudar e orientar na inclusão do novo componente.

Hierarquia de Cores

Cores para quadro de processos assíncronos e loops

Lembrando que, por padrão a ordem da inclusão das cores deve seguir a ordem estabelecida nesta tabela, ou seja, caso exista apenas um quadro com loop no fluxograma, ele deve possuir a cor EEEEEE, caso seja adicionado um novo quadro, ele deverá ter a cor DDDDDD, e assim sucessivamente.

Código em hexadecimal	Cores
EEEEEE
DDDDDD
CCCCCC
BBBBBB
AAAAAA

Cores para conectores

Identificação do Conector	Código em hexadecimal	Cores
1	DAE8FC
2	D5E8D4
3	FFE6CC
4	E1D5E7

Camadas

Para acessar as camadas do diagrama, pode-se acessar o menu Visualização > Camadas, sendo possível acessar também pelo atalho Ctrl + Shift + L. Que habilitará o seguinte pop-up:

Possuindo as seguintes funcionalidades:

Realiza o bloqueio/desbloqueio da edição dos componentes da camada;
Exibe ou oculta os componentes da camada;
Exclui a camada selecionada;
Move os componentes selecionadas para uma outra camada escolhida pelo usuário;
Abre a janela para edição dos dados da camada (sem uso atualmente);
Duplica a camada selecionada;
Adiciona uma nova camada em branco.

Sendo que ao adicionar mais de uma camada, é possível ordenar quais itens devem ficar posicionados sobre outros, como no exemplo à seguir:

Onde a camada "estrutura" é a primeira camada e está sobre todas as outras, em seguida temos a camada "fluxo" e no fundo do fluxograma temos a camada "ajuda". Ou seja, caso mais de um componente ocupe o mesmo espaço, essa ordem será respeitada para sobreposição dos itens.

A utilização de camadas em fluxogramas é obrigatória ao implementar fluxogramas funcionais, loops ou processos assíncronos. Caso contrário, o seu uso é opcional.

Estruturas

Durante a criação de fluxogramas, nos depararemos com situações que exigem mais do que simples componentes, nestes casos são necessárias algumas notações diferenciadas para que a ideia do fluxograma seja bem representada e permaneça fiel ao processo, à seguir, vamos ver algumas delas.

Loop

Ao representarmos um loop, utilizaremos camadas diferentes, sendo que utilizaremos uma camada para o fluxograma e a "moldura" do loop e outra camada para o fluxo interno do loop. A condição de parada do loop deve ficar fora da moldura do loop, pois é ela quem define se entraremos no laço ou não.

Para saber qual cor de preenchimento você deve utilizar para o quadro referente ao loop, viste a página sobre a hierarquia das cores.

Processo Assíncrono

Um processo assíncrono é aquele que pode ser chamado em qualquer etapa de um determinado fluxo, e que após concluído, retorna ao fluxo padrão partindo do estado que o chamou.

Para saber qual cor de preenchimento você deve utilizar para o quadro referente ao processo assíncrono, viste a página sobre a hierarquia das cores.

Fluxogramas Funcionais

Fluxogramas funcionais são estilos de fluxogramas que contam com mais de um setor/departamento envolvido no processo, utilizados para indicar as responsabilidades de cada departamento, em cada etapa do fluxo.

Departamentos são divididos por linhas horizontais.
Etapas do processo são divididas por linhas verticais.