SuperAPI AI Directory

specsfy-monorepo-documentator

Writing & research

View repository

Updated 10-15 09:16

About this skill

Documentar o monorepo Specsfy
  1. Executar na raiz:
python3 -B \
  .agents/skills/specsfy-monorepo-documentator/scripts/collect_monorepo_evidence.py \
  --workspace .
  1. Interromper se o coletor informar que o diretório não representa o monorepo oficial.
  2. Ler integralmente o AGENTS.md da raiz e as instruções dos módulos afetados.
  3. Ler docs/develop/context/README.md e apenas os contextos roteados pela mudança.
  4. Ler o padrão documental antes de editar topologia, classificação ou percurso de leitura.
  5. Comparar cada afirmação com código, teste, manifest, configuração, schema, documentação operacional ou contexto normativo do módulo responsável.
  6. 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/. Manter docs/user/installation.md como guia canônico de instalação e uma página em docs/user/skills/ para cada skill base. Manter a jornada pedagógica única em docs/user/reading-order.txt, começando pelo método, seguida de instalação, primeira entrega, fluxo base, operação e uso avançado.
  7. Usar links relativos entre módulos. URLs públicas usam https://github.com/promovaweb/specsfy.
  8. Após qualquer mudança em docs/user/, versionar e reconstruir PDF, EPUB e manifesto com make ebook.
  9. 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.md ou specs/ 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.