SuperAPI AI 工具集

md-docs

智能体与模型

查看项目

更新于 10-16 03:16

技能介绍

用途:md-docs 用于管理 Claude Code 工作流中的项目文档,包括上下文文件、README 与智能体指令。它强调先分析真实代码库结构与内容,再创建或更新文档,避免盲目生成。

主要能力:更新上下文文件(校验并修正 AGENTS.md,可选 DOCS.md 与 CONTRIBUTING.md;CLAUDE.md 为 AGENTS.md 的符号链接,无需单独处理);生成或更新 README.md;更新已存在的 CONTRIBUTING.md;从零初始化 AGENTS.md。支持参数:--dry-run 预览不写入、--preserve 保留现有结构仅修正不准确处、--thorough 深度分析、--minimal 最小化、--full 完整生成。

使用方式:先确认处于 git 仓库(git rev-parse --git-dir),检查目标文件是否存在(ls -la CLAUDE.md AGENTS.md DOCS.md README.md CONTRIBUTING.md)。更新前会创建备份,如 cp AGENTS.md AGENTS.md.backup;必要时创建符号链接 ln -sf AGENTS.md CLAUDE.md。DOCS.md 与 CONTRIBUTING.md 仅在已存在时处理,不会自动创建。

适用场景:初始化新项目文档、更新已有文档、确保上下文文件与当前代码一致。

限制:DOCS.md 为可选,仅适用于有 API 或公共接口的项目;CONTRIBUTING.md 为可选,仅在仓库已有贡献指南时处理;非 git 仓库仍可运行但会跳过 git 相关功能。具体实现细节可参考 references 目录下的文档。