SuperAPI AI 工具集

md-docs

写作与研究

查看项目

更新于 10-16 03:16

技能介绍

用途:管理 Claude Code 项目文档,包括上下文文件、README 与智能体说明,在新建项目或文档过期时,依据真实代码库结构、文件内容与约定进行校验和更新,强调验证优先而非盲目生成。

主要能力:更新上下文文件(对照代码库修正 CLAUDE.md、AGENTS.md,可选 DOCS.md、CONTRIBUTING.md);生成或更新 README.md(从包元数据、Git 信息、目录结构提取内容);仅在 CONTRIBUTING.md 已存在时更新它,不会自动创建;从零初始化项目专属 CLAUDE.md;DOCS.md 默认不创建,仅在项目含公共 API、导出函数或复杂类型时手动建立。

使用方式:先执行 git rev-parse --git-dir 确认处于 Git 仓库,再用 ls -la CLAUDE.md AGENTS.md DOCS.md README.md CONTRIBUTING.md 检查目标文件。支持参数 --dry-run(预览不写入)、--preserve(保留原有结构仅修正不准确处)、--thorough/--full(深度全面分析)、--minimal(最小化)、--force(覆盖安全检查)。覆盖前会创建 .backup 备份,如 cp CLAUDE.md CLAUDE.md.backup,且不自动删除备份。

写作风格:简洁、命令式、专家对专家,使用标题、列表与代码块,所有命令和路径需对照代码库核实。

限制:仅适用于上述 Markdown 文档;不在非 Git 仓库时部分功能受限;CONTRIBUTING.md 缺失时跳过且不自动创建;参考文档细节部分资料截断,具体模板与检测策略暂未完整提供。