Skip to Content
DocumentaçãoDocumentation Roadmap

Roadmap de Documentação AIOS

🌐 EN | PT | ES


Criado: 2026-01-26 Status: Ativo Responsável: @devops (Gage)


Resumo Executivo

Este roadmap aborda 33 documentos faltantes identificados durante a auditoria de links da documentação. Após análise, eles são categorizados em:

CategoriaQuantidadeAção
Criar10Novos documentos necessários
Consolidar8Mesclar em docs existentes
Descartar15Obsoletos/redundantes

Fase 1: Alta Prioridade (Imediato)

1.1 Segurança e Configuração

DocumentoLocalizaçãoComplexidadeDescrição
mcp-api-keys-management.mddocs/en/architecture/MédiaSegurança e gerenciamento de chaves API MCP

Esboço do conteúdo:

  • Melhores práticas de armazenamento de chaves API
  • Configuração de variáveis de ambiente
  • Secrets do Docker MCP Toolkit
  • Considerações de segurança
  • Procedimentos de rotação

1.2 Onboarding de Usuários

DocumentoLocalizaçãoComplexidadeDescrição
v4-quick-start.mddocs/en/installation/SimplesGuia de início rápido para novos usuários

Esboço do conteúdo:

  • Setup em 5 minutos
  • Checklist de pré-requisitos
  • Primeira ativação de agente
  • Passos de verificação
  • Links para próximos passos

Fase 2: Prioridade Média (Próximo Sprint)

2.1 Guias para Desenvolvedores

DocumentoLocalizaçãoComplexidadeDescrição
agent-tool-integration-guide.mddocs/en/architecture/ComplexaComo integrar ferramentas com agentes
dependency-resolution-plan.mddocs/en/architecture/MédiaEstratégia de dependência de módulos

2.2 Documentos de Planejamento

DocumentoLocalizaçãoComplexidadeDescrição
stories/1.8-phase-3-workflow-orchestration.mddocs/en/stories/MédiaStory do módulo de orquestração
stories/1.9-missing-pv-agents.mddocs/en/stories/SimplesRastreamento de completude de agentes

2.3 Documentação de Referência

DocumentoLocalizaçãoComplexidadeDescrição
coderabbit/README.mddocs/en/guides/coderabbit/SimplesGuia de configuração do CodeRabbit

Fase 3: Baixa Prioridade (Backlog)

3.1 Arquitetura

DocumentoLocalizaçãoComplexidadeDescrição
multi-repo-strategy.mddocs/en/architecture/ComplexaOrganização multi-repositório
mvp-components.mddocs/en/architecture/SimplesComponentes mínimos viáveis
schema-comparison-sqlite-supabase.mddocs/en/architecture/MédiaComparação de schemas de banco de dados

Plano de Consolidação

Estes documentos devem ser mesclados na documentação existente:

Documento FaltanteMesclar EmAção
installation/migration-migration-guide.mdmigration-guide.mdAdicionar seção v2.0→v4.0.4
migration-migration-guide.mdmigration-guide.mdMesmo que acima
coderabbit-integration-decisions.mdarchitecture/adr/Criar novo ADR
technical-review-greeting-system-unification.mdguides/contextual-greeting-system-guide.mdAdicionar seção técnica
hybrid-ops-pv-mind-integration.mdarchitecture/high-level-architecture.mdAdicionar seção de integração
repository-migration-plan.mdmigration-guide.mdAdicionar seção de migração de repo
internal-tools-analysis.md.aios-core/infrastructure/tools/README.mdReferenciar existente
.aios-core/core/registry/README.mdJÁ EXISTENenhuma ação necessária

Lista de Descarte

Estes documentos são obsoletos ou redundantes e NÃO devem ser criados:

DocumentoMotivo
architect-Squad-rearchitecture.mdCoberto em squad-improvement-recommended-approach.md
analysis/Squads-dependency-analysis.mdAnálise pontual; sistema de squads maduro
analysis/Squads-structure-inventory.mdDinâmico; melhor mantido via scripts
analysis/subdirectory-migration-impact-analysis.mdMigração concluída
analysis/tools-system-analysis-log.mdLogs efêmeros; sistema de ferramentas estável
analysis/tools-system-gap-analysis.mdAnálise de gaps concluída
tools-system-brownfield.mdIncorporado na task analyze-brownfield.md
tools-system-handoff.mdDoc de processo, não permanente
tools-system-schema-refinement.mdRefinamento concluído
analysis/scripts-consolidation-analysis.mdScripts já consolidados
analysis/repository-strategy-analysis.mdEstratégia definida no ARCHITECTURE-INDEX
SYNKRA-REBRANDING-SPECIFICATION.mdRebranding concluído
multi-repo-strategy-pt.mdUsar estrutura docs/pt-BR/ em vez disso

Cronograma de Implementação

Semana 1 (Fase 1) ├── Dia 1-2: mcp-api-keys-management.md └── Dia 3-4: v4-quick-start.md Semana 2-3 (Fase 2) ├── Dia 1-3: agent-tool-integration-guide.md ├── Dia 4-5: dependency-resolution-plan.md ├── Dia 6: stories/1.8 & 1.9 └── Dia 7: coderabbit/README.md Semana 4 (Fase 3 + Consolidação) ├── Dia 1-2: Tarefas de consolidação ├── Dia 3-4: multi-repo-strategy.md (se necessário) └── Dia 5: mvp-components.md

Requisitos de Tradução

Todos os novos documentos devem ser criados em 3 idiomas:

  • docs/en/ - Inglês (primário)
  • docs/pt-BR/ - Português (Brasil)
  • docs/es/ - Espanhol

Fluxo de tradução:

  1. Criar versão em inglês primeiro
  2. Usar @dev ou agente de tradução para PT-BR e ES
  3. Revisar traduções para precisão técnica

Critérios de Sucesso

  • Todos os documentos da Fase 1 criados e revisados
  • Todos os documentos da Fase 2 criados e revisados
  • Tarefas de consolidação concluídas
  • Zero links quebrados na documentação
  • Todos os documentos disponíveis em 3 idiomas

Acompanhamento de Progresso

Fase 1

  • mcp-api-keys-management.md (EN/PT-BR/ES)
  • v4-quick-start.md (EN/PT-BR/ES)

Fase 2

  • agent-tool-integration-guide.md (EN/PT-BR/ES)
  • dependency-resolution-plan.md (EN/PT-BR/ES)
  • stories/1.8-phase-3-workflow-orchestration.md (apenas EN)
  • stories/1.9-missing-pv-agents.md (apenas EN)
  • coderabbit/README.md (EN/PT-BR/ES)

Fase 3

  • multi-repo-strategy.md (EN/PT-BR/ES)
  • mvp-components.md (EN/PT-BR/ES)
  • schema-comparison-sqlite-supabase.md (apenas EN)

Consolidação

  • Seção de guia de migração v2.0→v4.0.4 adicionada
  • ADR para decisões do CodeRabbit criado
  • Seção técnica do guia do sistema de saudação adicionada

Última Atualização: 2026-01-28 Próxima Revisão: Após conclusão da Fase 1