Documentar o monorepo Specsfy
- Executar na raiz:
python3 -B \
.agents/skills/specsfy-monorepo-documentator/scripts/collect_monorepo_evidence.py \
--workspace .
- Interromper se o coletor informar que o diretório não representa o monorepo oficial.
- Ler integralmente o
AGENTS.mdda raiz e as instruções dos módulos afetados. - Ler
docs/develop/context/README.mde apenas os contextos roteados pela mudança. - Ler o padrão documental antes de editar topologia, classificação ou percurso de leitura.
- Comparar cada afirmação com código, teste, manifest, configuração, schema, documentação operacional ou contexto normativo do módulo responsável.
- Atualizar ambos os percursos quando a mudança alcançar arquitetura e uso:
- documentação para usuários em
docs/user/; - documentação técnica em
docs/develop/. Manterdocs/user/installation.mdcomo guia canônico de instalação e uma página emdocs/user/skills/para cada skill base. Manter a jornada pedagógica única emdocs/user/reading-order.txt, começando pelo método, seguida de instalação, primeira entrega, fluxo base, operação e uso avançado.
- documentação para usuários em
- Usar links relativos entre módulos. URLs públicas usam
https://github.com/promovaweb/specsfy. - Após qualquer mudança em
docs/user/, versionar e reconstruir PDF, EPUB e manifesto commake ebook. - Executar testes focais dos módulos, regressão integrada e revisar o único status e diff do monorepo.
Política de evidência
- Registrar como fato apenas o que uma fonte atual comprovar.
- Distinguir decisão vigente, estado implementado, inferência e lacuna.
- Preservar o estado observado quando fontes divergirem.
- Não copiar inventários extensos derivados de manifests, rotas, schemas ou testes.
- Não copiar segredos, dados de produção ou conteúdo interno sem finalidade.
- Não criar
plan.md,tasks.md,research.md,data-model.mdouspecs/na raiz.
Fronteira com o documentador do consumidor
Esta skill documenta a metodologia, a arquitetura do monorepo e seus guias
oficiais. Para <projeto>/docs/ de uma aplicação consumidora, carregue
$specsfy-documentator.
Exclusividade local
- Manter a fonte somente em
.agents/skills/specsfy-monorepo-documentator/. - Expor a mesma fonte ao Claude pelo symlink
.claude/skills/specsfy-monorepo-documentator. - Não criar skill homônima em
skills/nem incluí-la no instalador. - Em pedido somente de auditoria, coletar e ler sem publicar arquivos.