mcpField
S
specsfy-monorepo-documentator

specsfy-monorepo-documentator

github.com/promovaweb开发87422 次安装1 周前更新
代码仓库

关于 specsfy-monorepo-documentator

面向 Specsfy monorepo 贡献者的文档编写技能,用于维护用户文档和技术文档。它强调以证据核对内容、遵循仓库指定的阅读路径,并在用户文档变更后重建电子书产物。

主要功能

  1. 01编辑前收集 monorepo 证据
  2. 02遵循仓库及模块指引
  3. 03依据权威来源核实陈述
  4. 04维护用户文档与技术文档
  5. 05用户文档变更后重建 PDF、EPUB 和清单
  6. 06检查测试、状态与差异

适用场景

  1. 01记录架构或模块变更
  2. 02同步更新官方用户指南和技术文档
  3. 03依据当前代码与测试审查文档

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/promovaweb/specsfy --skill specsfy-monorepo-documentator

安装后在 Claude Code 中输入/specsfy-monorepo-documentator确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
documentation-standard.md
scripts/
collect_monorepo_evidence.py

详细介绍

记录 Specsfy 单体仓库文档

  1. 在根目录执行:
python3 -B \
  .agents/skills/specsfy-monorepo-documentator/scripts/collect_monorepo_evidence.py \
  --workspace .
  1. 如果收集器报告该目录并非官方单体仓库,则停止。
  2. 完整阅读根目录的 AGENTS.md 和受影响模块的说明。
  3. 阅读 docs/develop/context/README.md,以及仅与变更相关的上下文。
  4. 在编辑拓扑、分类或阅读路径前,阅读文档规范。
  5. 将每项陈述与负责模块的代码、测试、manifest、配置、schema、运维文档或规范性上下文进行核对。
  6. 当变更涉及架构和使用方式时,更新这两类文档:
    • 面向用户的文档,位于 docs/user/;
    • 技术文档,位于 docs/develop/。 将 docs/user/installation.md 作为规范安装指南,并为每个基础 skill 在 docs/user/skills/ 中保留一个页面。将唯一的教学式阅读路径保留在 docs/user/reading-order.txt,依次从方法开始,接着是安装、首次交付、基础流程、运维和高级用法。
  7. 在模块之间使用相对链接。公开 URL 使用 https://github.com/promovaweb/specsfy。
  8. 对 docs/user/ 做出任何更改后,使用 make ebook 版本化并重新构建 PDF、EPUB 和 manifest。
  9. 执行模块的重点测试和集成回归测试,并检查整个单体仓库唯一的状态和 diff。

证据政策

  • 仅将当前来源能够证实的内容记录为事实。
  • 区分当前有效的决策、已实现状态、推断和空缺。
  • 如果来源存在分歧,则保留观察到的状态。
  • 不复制从 manifests、路由、schemas 或测试中整理出的冗长清单。
  • 不复制秘密、生产数据或无关的内部内容。
  • 不要在根目录创建 plan.md、tasks.md、research.md、data-model.md 或 specs/。

与消费者文档编写器的职责边界

此 skill 记录方法、单体仓库架构及其官方指南。对于消费者应用的 <projeto>/docs/,请加载 $specsfy-documentator。

本地独占性

  • 仅在 .agents/skills/specsfy-monorepo-documentator/ 中保留源文件。
  • 通过符号链接 .claude/skills/specsfy-monorepo-documentator 向 Claude 提供相同的源文件。
  • 不要在 skills/ 中创建同名 skill,也不要将其纳入安装程序。
  • 如果请求仅涉及审计,则只收集和阅读,不发布文件。

评论

支持 Markdown