Documentação técnica da base e dos datapacks

A documentação técnica da base e dos datapacks explica como os dados do FootSim são estruturados, editados, validados, importados e distribuídos. Ela é essencial para desenvolvimento interno, manutenção futura e eventual participação da comunidade na criação de conteúdo.

Esse item não é documentação de gameplay para o jogador comum. É documentação técnica e semi-técnica para quem vai mexer em dados, editor, datapacks, importadores ou conteúdo regional. Já existe documentação relevante para importação, datapacks, competições, overlays e editor, mas parte da documentação principal está desatualizada em relação ao código real. O objetivo é transformar a documentação em uma referência confiável, especialmente para schema, paths, migrations, datapacks e fluxos atuais.

Escopo incluído

• Documentação do schema
• Documentação de migrations
• Documentação de entidades principais
• Documentação de competições
• Documentação de datapacks
• Documentação de import/export
• Documentação do pipeline de dados
• Documentação do editor
• Documentação de validação
• Documentação de overlays quando aplicável
• Exemplos de arquivos de dados
• Exemplos de datapacks
• Guias para desenvolvimento interno
• Guias para modders quando aplicável
• Notas de compatibilidade
• Limitações conhecidas
• Regras de contribuição de dados quando aplicável
• Atualização de docs antigas que citam tabelas, comandos ou fluxos removidos

Fora de escopo

• Wiki pública completa desde o início
• Documentação perfeita de cada campo antes de estabilização
• Manual de jogador comum
• Tutorial interativo dentro do jogo
• Documentação de APIs online inexistentes
• Curso completo de modding
• Tradução completa da documentação para todos os idiomas
• Garantia de que a documentação nunca fique temporariamente atrás do código
• Documentação de campos experimentais como se fossem finais
• Suporte individual a todo modder
• Considerar docs desatualizadas como referência canônica sem revisão
• Prometer fluxos de UI que ainda não existem, como gerenciamento completo de datapacks em settings se essa tela ainda não estiver implementada

Critérios de conclusão

• Desenvolvedores entendem como a base é estruturada.
• Migrations importantes estão explicadas.
• Datapacks têm formato documentado.
• Import/export tem instruções claras.
• Validações são compreensíveis.
• Entidades principais têm documentação suficiente.
• A documentação não cita tabelas removidas como se fossem atuais.
• A documentação não descreve caminhos ou fluxos que contradizem o código.
• Novas tabelas importantes são documentadas.
• Modders conseguem criar conteúdo simples sem ler o código inteiro.
• A documentação ajuda a evitar dados quebrados.
• O status real de recursos como datapacks, editor e compatibilidade fica claro.