P A T H

Documentando o seu fluxo de trabalho

O que você vai aprender?

Se você já precisou dar manutenção em um fluxo de trabalho criado por outra pessoa, sabe a importância da documentação. Apesar de cada ferramenta possuir uma função específica, é imprescindível que se conheça o propósito de cada etapa do fluxo, assim como as regras de negócio envolvidas no processo. Além disso, a organização visual facilita a compreensão e permite identificar a etapa que necessita de alteração. 

Nessa dica, vamos dar algumas sugestões para documentar e organizar o seu fluxo de trabalho.

INTRODUÇÃO

Hoje, nosso fluxo funciona perfeitamente, então não precisamos nos preocupar com erros de execução. Entretanto, vamos concentrar nossos esforços em organizar as ferramentas e documentar o fluxo. Este é o workflow inicial:

Passo 1: Dê um nome auto explicativo para seu fluxo

Na medida do possível, tente “batizar” o seu fluxo de forma que o nome dele dê uma ideia de seu propósito. Cuidado para não deixar o nome excessivamente longo.

A mudança pode ser feita através do “Salvar como…” ou alterando diretamente o nome do arquivo a partir do seu sistema operacional.com a cor azul

Passo 2: Retire as ferramentas não essenciais

Durante o desenvolvimento, utilizamos ferramentas para validar os dados, criamos caminhos alternativos que não levam a lugar nenhum, criamos etapas desnecessárias ou redundantes.

Uma vez homologado, o fluxo pode ter esses passos eliminados. Localize-os e retire-os do fluxo. Os primeiros convidados a se retirar são as ferramentas Browse, que não alteram os dados e podem aumentar o tempo de processamento.

Passo 3: Utilize as anotações para identificar os passos

Toda ferramenta Alteryx possui uma propriedade, chamada Anotação, para que você possa detalhar seu propósito. Descreva a função de cada ferramenta de forma que você (ou a pessoa que for dar manutenção no seu fluxo) saiba porque ele existe.

Passo 4: Organize as ferramentas na área de trabalho

Sempre que possível:

  • Tente manter o fluxo linear;
  • Mantenha bifurcações paralelas;
  • Evite que linhas se cruzem (utilize conexões wireless);
  • Evite que linha fiquem sobre as anotações
  • Tente manter as ferramentas equidistantes.

Um fluxo visualmente agradável não vai rodar mais rápido, porém permite que você identifique o trecho de seu interesse.

Passo 5: Utilize Contêineres para agrupar ferramentas

Em fluxos mais complexos, uma boa prática é colocar as ferramentas que estão trabalhando para um objetivo parcial agrupadas em um contêiner. Visualmente, será mais fácil identificar a funcionalidade que está sendo implementada se as ferramentas estiverem confinadas em um retângulo etiquetado.

Esta dica é opcional e não é tão relevante em fluxos menores, como nosso exemplo. Também não é mandatório que todas as ferramentas estejam dentro de um contêiner. Apenas as etapas críticas devem ser destacadas.

Para fins didáticos, vamos colocar contêineres nas etapas iniciais.

Passo 6: Use a ferramenta comentário

Por último, utilize a ferramenta Comment para descrever as regras de negócio que compõem seu fluxo. Você pode utilizar várias caixas de comentário para separar as informações, e depois colocar todas elas em um contêiner próprio.

O resultado final fica assim:

26 de agosto de 2020

Pronto, você aprendeu a documentar seu fluxo de trabalho no Alteryx!

Language