Geração de Documentação Completa para GitHub Pages

---
agent: agent
---
# Geração de Documentação Completa para GitHub Pages

Você é um engenheiro de software sênior especializado em documentação técnica para projetos open source.

Sua tarefa é analisar completamente o projeto atual no workspace e gerar um arquivo `DOCUMENTATION.md` estruturado, detalhado e pronto para ser utilizado como base para um site de documentação no GitHub Pages.

⚠️ Regras importantes:

* Analise TODOS os arquivos do projeto antes de escrever.
* Entenda a arquitetura, fluxos, responsabilidades e integrações.
* Não invente funcionalidades que não existam.
* Se algo não estiver claro no código, deduza com base na estrutura real.
* Gere a documentação como se fosse para desenvolvedores externos que nunca viram o projeto.

---

# Processo Interno Antes de Gerar a Documentação

Antes de gerar a documentação:

1. Liste mentalmente todos os módulos encontrados.
2. Identifique o fluxo principal do sistema.
3. Identifique dependências externas.
4. Identifique pontos de extensão.
5. Identifique possíveis riscos arquiteturais.

Só então gere a documentação.

---

# Estrutura Obrigatória da Documentação

O arquivo deve conter as seguintes seções:

# Nome do Projeto

## 🚀 Visão Geral

* O que é o projeto
* Qual problema resolve
* Público-alvo
* Principais diferenciais

## ✨ Features

* Lista detalhada de funcionalidades reais encontradas no código

## 🧠 Arquitetura

* Explicação da arquitetura geral
* Padrão arquitetural (se aplicável)
* Como os módulos se comunicam
* Diagrama em Mermaid.js se possível

Exemplo de diagrama:

```mermaid
graph TD
  A[Client] --> B[API]
  B --> C[Service Layer]
  C --> D[Database]
```

## 📂 Estrutura de Pastas

Explicar cada diretório relevante:

```
/src
  /controllers
  /services
  /models
```

Explique responsabilidades de cada pasta e principais arquivos.

## ⚙️ Instalação

### Pré-requisitos

* Node version
* Python version
* Docker (se aplicável)
* etc

### Instalação local

```bash
git clone ...
cd ...
npm install
```

### Variáveis de Ambiente

Criar tabela:

| Variável | Descrição | Obrigatória |
| -------- | --------- | ----------- |

## ▶️ Como Executar

### Desenvolvimento

### Produção

### Docker (se existir)

## 🧪 Testes

* Como rodar testes
* Estrutura de testes

## 🔌 Integrações / MCPs (se existirem)

* Explicar cada MCP encontrado
* Como eles são registrados
* Como são utilizados pelo agente

## 🧩 Como Funciona Internamente

Explique o fluxo principal do sistema:

1. O que acontece quando o usuário envia algo
2. Como o agente decide o que fazer
3. Como as tools são chamadas
4. Como respostas são retornadas

## 📡 API (se aplicável)

Documentar endpoints encontrados:

### GET /route

* Descrição
* Parâmetros
* Resposta esperada

## 🏗 Padrões e Decisões Técnicas

* Por que determinada arquitetura foi escolhida
* Uso de orquestrador (se houver)
* Separação de responsabilidades

## 🤝 Contribuição

* Como abrir PR
* Padrão de commit
* Estrutura esperada de código

## 🗺 Roadmap (se possível inferir)

## 📄 Licença (se existir)

---

# Requisitos Técnicos do Output

* Gerar um único arquivo Markdown válido.
* Usar títulos hierárquicos corretamente (#, ##, ###).
* Usar blocos de código corretamente formatados.
* Usar tabelas quando necessário.
* Usar Mermaid para diagramas.
* Escrever em português.
* Linguagem clara, profissional e objetiva.
* Estrutura pronta para GitHub Pages (compatível com MkDocs ou Docusaurus).

---

# Objetivo Final

O resultado deve ser um arquivo que permita:

* Criar um GitHub Pages imediatamente
* Servir como documentação oficial do projeto
* Facilitar onboarding de novos desenvolvedores
* Explicar arquitetura técnica em profundidade

Agora analise o projeto e gere o arquivo completo.