用途:当用户要求“为仓库生成文档”“创建/更新 README”“编写 API 文档”“撰写架构文档”或“贡献指南”时使用,也可用于说明某仓库如何与其他仓库连接。
主要能力:生成或更新 README.md、API 文档、CONTRIBUTING.md、ARCHITECTURE.md,以及可选的 INTEGRATIONS.md。每份文档需包含“集成/相关仓库”章节,说明本仓库依赖哪些仓库、被哪些仓库消费、涉及的外部服务与数据流。
使用方式:先分析仓库结构(用 Glob 查找 README.md、package.json、pyproject.toml、go.mod、Cargo.toml、pom.xml 等,识别 src/、lib/ 等源码目录与配置、已有文档),再发现跨仓库集成(搜索内部包导入、API 客户端、外部服务引用、.gitmodules 等),并检测语言、框架、构建与测试工具。随后按 examples/ 中的模板生成文档;更新已有文档时先读后改,保留原有语气与格式。可用脚本:python skills/repo-docs/scripts/find-integration-points.py /path/to/repo 和 analyze-repo-structure.py。
写作要求:对集成点要具体点名仓库并解释关系;文档自包含且相互交叉引用;简洁可扫读,多用要点、表格与代码示例,避免重复,README 目标 3-5 分钟读完;示例取真实代码并验证可用。
限制:资料未说明支持的平台、安装方式、收费或价格,这些暂未提供。生成效果依赖仓库实际结构与可访问性。