Documentações

Documentação de Automações - Guia Rápido

3 min read

Quickstart: Plataforma de Documentação Centralizada de Automações

Este sistema vital serve como a centralização para documentar todos os nossos fluxos de trabalho automatizados (Hyperflow, N8N, HubSpot), prevenindo quebras, agilizando a manutenção e garantindo total transparência para desenvolvedores e stakeholders. Seu principal objetivo é converter o conhecimento técnico difuso em ativos estruturados e acessíveis, tornando a gestão de automações robusta e escalável.

Estado de Cobertura dos Fluxos

Como Documentar e Publicar um Novo Fluxo (Em 3 Passos Rápidos)

Para garantir que nossas automações sejam sempre compreendidas e fáceis de manter, seguir este fluxo de documentação e publicação é essencial. Este guia rápido foca no processo de publicação, assumindo que seu ambiente já está configurado (veja o Guia Completo de Desenvolvedores para detalhes de setup).

Passo 1: Crie a Documentação do seu Fluxo

A documentação de um fluxo é construída a partir de seus nós individuais e consolidada com o auxílio de IA para garantir padronização e agilidade.

  1. Documente O Básico de Cada Nó Individualmente (.md Atômico):

    • Para cada nó do seu fluxo de automação, abra o Obsidian e utilize o sistema de templates para criar uma nova nota baseada em guides/templates/node.md.
    • Este template é interativo e irá guiá-lo com perguntas específicas para cada tipo de nó (Condição, Chat, Jump, HTTP Request, etc.), garantindo que os dados pertinentes sejam capturados de forma concisa.
    • Salve cada nota de nó individualmente em uma pasta temporária (ou em uma estrutura organizada para os nós do seu fluxo).
    • (Para detalhes e exemplos dos tipos de nó, consulte Referência de Tipos de Nó)

  2. Consolide e Gere o Documento do Fluxo (com IA):

    • Após documentar todos os nós em notas individuais, junte o conteúdo de todas essas notas .md em um único arquivo Markdown temporário.
    • Utilize uma IA com acesso ao guides/template-doc-fluxo.md (o template geral de fluxo) e alimente-a com o arquivo Markdown consolidado dos nós. A IA irá processar e estruturar um documento .md completo do seu fluxo, integrando as informações dos nós.
    • Salve este documento Markdown final (ex: flows/hyperflow/meu-novo-fluxo.md) na pasta flows/<plataforma>/<nome-do-fluxo>/, seguindo a estrutura de pastas apropriada.
    • (Para detalhes sobre como usar a IA e o template-doc-fluxo.md, consulte Guia Completo - Geração com IA)

Passo 2: Publique Suas Alterações

Com o documento .md final do fluxo pronto e salvo na pasta correta, é hora de publicá-lo para que fique acessível online. Certifique-se de que você está no diretório raiz do seu repositório local clonado (o mesmo onde você executou git clone e npm install). Em uma CLI (da IDE, por exemplo):

  1. Gere o Site Estático: 
    npx quartz build
    (Este comando converte seus arquivos Markdown em HTML/CSS para o site.)
  2. Prepare para o Commit (Git): 
    git add .
    (Adiciona todos os arquivos alterados e recém-gerados ao “stage” do Git.)
  3. Comite Suas Mudanças: 
    git commit -m "docs: Adiciona documentação para [Nome do Fluxo]"
    (Crie uma mensagem de commit clara e concisa.)
  4. Envie para o Repositório: 
    git push origin main
    (Isso enviará suas mudanças para o repositório Git central. O Vercel detectará essa mudança e automaticamente publicará a nova versão do site online.)

Passo 3: Verifique a Publicação Online

Após o git push, a Vercel iniciará o processo de deploy. Em alguns minutos, sua nova documentação estará visível em nosso portal de documentação. Acesse o portal e use a busca ou navegação para confirmar que seu fluxo está lá e acessível.

Quer Mais Detalhes?

Para uma compreensão completa da stack tecnológica, configuração de ambiente, regras detalhadas de documentação, padrões de contribuição e manutenção, consulte o Guia Completo de Desenvolvedores.

Graph View

Backlinks