DEV Community

loading...

Documentação básica da automação, o que colocar?

Michelle Azevedo
front end developer and yogini 🧘‍♀️
・2 min read

É importante que, ao entregar uma automação para um cliente, deixemos um pequeno manual para o uso e eventuais manutenções da ferramenta.

Não precisa ser aquela documentação com print de cada clique e um passo a passo detalhado, mas podemos ir além do que explicar tudo em uma ligação gravada e deixar por isso.

Aqui vão algumas sugestões do que colocar no manual:

Instruções / recomendações básicas:

É possível executar outras atividades durante o processo, porque ele roda no background

O nome dos arquivos devem sempre seguir tal padrão, pois a automação extrai dados via regex

Caso o nome da coluna do arquivo mudar, alterar no processo Y dentro da automação

Os acessos estão inseridos dentro da automação (hehe acontece)

Antes de rodar o processo, atualizar o arquivo a ser processado, fazer isso no arquivo Config

Breve descritivo do processo:

  • Inicialização

    Mata os processos de planilhas e navegador rodando na máquina

    Lê os arquivos tal, tal e tal (colocar o caminho completo

    Enviar um array de dados a serem processados

  • Processamento

    Processa cada item do array

    Navega pelo site tal

    Faz upload de arquivos

  • Finalização

    Escreve uma dashboard

    Envia arquivos por e-mail

Frequência / Quantidade / Tempo

A automação roda de tanto em tanto tempo (todos os dias, as 6am?)

O usuário tal (colocar contato da pessoa) roda a automação na máquina dele

O processo demora em média 30 minutos

É feito o upload de aproximadamente 4mil arquivos de notas de pedidos

Inputs, Outputs e Caminhos usados

Pasta tal (inserir caminho inteiro)

Acessos no banco de dados X

Planilha com dashboard

E-mail com anexos tirados da pasta Y

Acesso ao site N

Nesse manual é importante colocar tudo o que faz com que a automação funcione normalmente, assim como um passo a passo de como o usuário pode alterar algumas coisas básicas. É legal criar um arquivo externo a automação, como uma tabela de excel, com os dados que mudam com frequência, programar a automação para pegar essas variáveis ali e então pedir para o usuário fazer qualquer alteração via Config.

No uipath tem algumas atividades que interagem com o usuário, durante o processamento, ele abre uma janela e pede para o usuário escolher uma pasta, digitar um texto na hora ou algo do tipo. Dependendo do processo, é uma boa alternativa.

Discussion (0)