🧠 ZimBot Brain

padrao_documentacao

Leitura de 2 min

Padrão de Documentação do ZimBot

Regra Fundamental

TODA configuração, skill, MCP, API ou mudança relevante DEVE ser documentada imediatamente no vault.

Não esperar o heartbeat - documentar no momento da criação/modificação.

O que documentar (obrigatório):

1. MCP Servers

  • Nome e comando
  • Status (habilitado/desabilitado)
  • Descrição e propósito
  • Método de autenticação
  • Ferramentas disponíveis (se filtradas)
  • Idioma/configurações especiais

2. Skills Criadas

  • Nome e categoria
  • Localização no filesystem
  • Descrição e capacidades
  • Pré-requisitos
  • Workflows principais
  • Pitfalls aprendidos

3. APIs e Integrações

  • Nome do serviço
  • Método de autenticação (token, OAuth, API key)
  • Escopos/permissões
  • Endpoints principais
  • Limitações conhecidas

4. Configurações do Hermes

  • Modelos configurados (orquestrador, subagentes)
  • Toolsets habilitados/desabilitados
  • Perfis criados (default, light, etc)
  • Otimizações aplicadas
  • Plugins ativos

5. Infraestrutura

  • VPSs e servidores
  • IPs, portas, acessos SSH
  • Domínios e certificados
  • Túneis e proxies
  • Cron jobs ativos

6. Workflows e Processos

  • Sequência de passos
  • Comandos executados
  • Decisões tomadas e justificativas
  • Resultados obtidos
  • Lições aprendidas

Onde documentar:

~/.hermes/vault/
├── Default/Config/
│   ├── mcp_servers.md
│   ├── skills_customizadas.md
│   ├── otimizacoes_hermes.md
│   └── persona_zimbot.md
├── Knowledge/Projects/
│   ├── [projeto]_obsidianbrain.md
│   └── _TEMPLATE_obsidianbrain.md
├── Infra/
│   ├── OracleVPS.md
│   ├── Contabo.md
│   ├── Hostinger.md
│   └── Cloudflare.md
└── BMAD/Workflows/
    └── [workflow].md

Formato de Documentação:

Para MCPs:

## [Nome do MCP]
- **Comando:** `comando args`
- **Status:** Habilitado/Desabilitado
- **Descrição:** O que faz
- **Autenticação:** Como autentica
- **Ferramentas:** Lista ou filtro aplicado
- **Configurações especiais:** Idioma, timeout, etc

Para Skills:

## [nome-skill]
- **Categoria:** media/productivity/devops/etc
- **Localização:** ~/.hermes/skills/[categoria]/[nome]/SKILL.md
- **Descrição:** O que faz
- **Capacidades:** Lista de capacidades
- **Pré-requisitos:** O que precisa estar instalado/configurado
- **Workflows:** Principais fluxos de uso
- **Pitfalls:** Armadilhas conhecidas

Para Projetos:

# [Nome do Projeto]
**Stack:** [tecnologias]
**Status:** [ativo|pausado|arquivado]
**Onde está:** [URL produção] | [GitHub] | [Drive]
**Decision Log:**
- YYYY-MM-DD: Decisão tomada
**Último commit:** [data]
**Próximos passos:** [se houver]

Heartbeat Automático:

  • Frequência: A cada 6 horas (00:00, 06:00, 12:00, 18:00)
  • Script: ~/.hermes/scripts/heartbeat-docs.sh
  • Cron job: heartbeat-documentacao-zimbot
  • Propósito: Capturar mudanças que não foram documentadas imediatamente

Regra de Ouro:

Se eu criei, configurei ou modifiquei algo relevante, eu documento AGORA.

O heartbeat é apenas um backup de segurança, não o método principal.

Criado em: 2026-06-12 Última atualização: 2026-06-12

Visão de gráfico