SuperAPI AI 工具集

md-docs

办公与效率

查看项目

更新于 10-15 22:17

技能介绍

用途:管理项目文档,针对 CLAUDE.md、AGENTS.md、README.md、CONTRIBUTING.md 等上下文文件进行创建、更新与初始化;不适用于通用写作。核心主张是“先验证、后生成”,先分析目录结构、文件与模式,再据实际代码库状态校验文档,避免盲目生成。

主要能力与工作流: 更新上下文文件:读取现有 AGENTS.md,提取可验证声明(路径、命令、结构、工具链),用 ls、cat package.json、cat pyproject.toml 等逐项核对,修正过期路径、错误命令、缺失章节与陈旧结构,并补充未记录的脚本、构建工具、测试框架。 更新 README:从配置文件(package.json、pyproject.toml、composer.json)识别语言与栈,抽取名称、版本、描述、许可证、脚本;--preserve 保留自定义章节,重生成标准章节。 更新 CONTRIBUTING:仅更新已有文件,绝不自动创建;自动检测包管理器、分支约定与测试命令。 更新 DOCS:若 DOCS.md 已存在,按 API 级文档处理并核对代码,同样只更新不创建。 初始化上下文:为无文档项目生成 AGENTS.md,再创建 CLAUDE.md 软链接。

可移植性:AGENTS.md 为通用上下文文件,兼容 Claude Code、Codex、Kilocode。若项目使用 CLAUDE.md,可将其视为 AGENTS.md 的软链接,迁移命令为 mv CLAUDE.md AGENTS.md && ln -sf AGENTS.md CLAUDE.md。

上下文文件层级按优先级排序:规则、技术栈、命令、约定、边界;使关键约束在上下文压缩后优先保留。

参数:所有工作流支持 --dry-run(预览)、--preserve(保留结构仅修错)、--minimal(快速高层)、--thorough(深度分析)。覆盖前备份,如 cp AGENTS.md AGENTS.md.backup,且不自动删除备份。

写作风格:简洁、命令式、面向专家、可扫读、准确;标题用句式大小写,不用 emoji;用 details 块折叠细节。README 反模式包括:先讲框架后讲问题、未定义先上术语、先理论后示例、无证据宣称。每次操作后输出摘要报告。校验要求:所有事实性声明对应当前代码库,无过期路径或组件名,Markdown 预览渲染正常。

限制:不自动创建 CONTRIBUTING.md 与 DOCS.md;具体命令与参数细节以各工作流文档(update-agents.md、update-readme.md、update-contributing.md、init-agents.md)为准,本资料未提供完整命令清单与安装方式。