specsfy-monorepo-documentator
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseDocumentar o monorepo Specsfy
为Specsfy单体仓库编写文档
- Executar na raiz:
bash
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 da raiz e as instruções dos módulos afetados.
AGENTS.md - Ler e apenas os contextos roteados pela mudança.
docs/develop/context/README.md - 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 . Manter
docs/develop/como guia canônico de instalação e uma página emdocs/user/installation.mdpara cada skill base. Manter a jornada pedagógica única emdocs/user/skills/, começando pelo método, seguida de instalação, primeira entrega, fluxo base, operação e uso avançado.docs/user/reading-order.txt
- 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 , versionar e reconstruir PDF, EPUB e manifesto com
docs/user/.make ebook - Executar testes focais dos módulos, regressão integrada e revisar o único status e diff do monorepo.
- 在根目录执行以下命令:
bash
python3 -B \
.agents/skills/specsfy-monorepo-documentator/scripts/collect_monorepo_evidence.py \
--workspace .- 若收集工具提示当前目录并非官方单体仓库,请立即停止操作。
- 完整阅读根目录下的以及受影响模块的说明文档。
AGENTS.md - 阅读,仅查看与本次变更相关的上下文内容。
docs/develop/context/README.md - 在编辑文档拓扑结构、分类或阅读路径前,请先阅读文档规范。
- 将每一项表述与对应模块的代码、测试用例、清单文件、配置、Schema、操作文档或规范上下文进行比对验证。
- 当变更涉及架构与使用层面时,同步更新两类文档路径:
- 下的用户文档;
docs/user/ - 下的技术文档。 请将
docs/develop/作为官方安装指南,并为每个基础skill在docs/user/installation.md下单独创建页面。保持docs/user/skills/中的学习路径唯一,顺序为:方法介绍、安装指南、首次交付、基础流程、操作说明、高级用法。docs/user/reading-order.txt
- 模块间使用相对链接,公共URL请使用。
https://github.com/promovaweb/specsfy - 每当目录内容发生变更后,需进行版本控制并执行
docs/user/命令重建PDF、EPUB格式文档及清单文件。make ebook - 执行模块聚焦测试、集成回归测试,并审核单体仓库的状态差异。
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.mdoudata-model.mdna raiz.specs/
- 仅记录有当前来源佐证的事实内容。
- 区分现行决策、已实现状态、推论信息与空白内容。
- 当来源存在分歧时,保留观察到的实际状态。
- 请勿复制来自清单、路由、Schema或测试的冗长清单内容。
- 请勿复制机密信息、生产数据或无明确用途的内部内容。
- 请勿在根目录创建、
plan.md、tasks.md、research.md或data-model.md目录。specs/
Fronteira com o documentador do consumidor
与消费类项目文档工具的边界
Esta skill documenta a metodologia, a arquitetura do monorepo e seus guias
oficiais. Para de uma aplicação consumidora, carregue
.
<projeto>/docs/$specsfy-documentator本skill用于记录方法论、单体仓库架构及官方指南。如需处理消费类应用的目录,请使用。
<projeto>/docs/$specsfy-documentatorExclusividade 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 nem incluí-la no instalador.
skills/ - Em pedido somente de auditoria, coletar e ler sem publicar arquivos.
- 仅在目录下保留源码。
.agents/skills/specsfy-monorepo-documentator/ - 通过符号链接将同一源码提供给Claude使用。
.claude/skills/specsfy-monorepo-documentator - 请勿在目录下创建同名skill,也不要将其加入安装工具。
skills/ - 仅在审核请求时,收集并读取文件但不发布。