SuperAPI AI 工具集

write-clear-readme

写作与研究

查看项目

更新于 10-15 20:28

技能介绍

用途:编写、重构、审查或润色项目 README.md,使其清晰、便于扫读。先读取仓库真实情况(清单、入口、AGENTS.md/CLAUDE.md 等),保留锚点与代码,并验证渲染。

主要能力:三种模式——默认(README 存在则审查,否则据仓库状态创作)、author(新建或整体重构)、audit(只读,检查折叠机会、锚点与总览完整性、清晰度)、polish(仅改措辞,保留结构)。提供三种折叠模式:Pattern A 按章节折叠(长文、多读者)、Pattern B 分组折叠(5+ 同类项、≤7 组)、Pattern C 按条目折叠(大量 API/命令/配置项)。另有通用规则(总览始终可见、锚点置于 details 外、每层规则统一、不嵌套、summary 后加 br、不写数字计数等)。audit 模式运行 scripts/audit_readme.py 输出 JSON 报告。

使用方式:/write-clear-readme 及各子命令加可选路径,如 /write-clear-readme author [path]、audit [path]、polish [path]。英文内容可调用 /humanize-en 去除 AI 腔(非英文跳过)。审查为只读,显式 author/polish 才授权编辑。

适用场景:长 README、技能库/插件/单体仓库索引、库/SDK/CLI 参考文档等。

限制:不评估文件内容选择是否正确,仅评估结构、锚点、折叠一致性与措辞;短文档(<5 节、<300 行)不建议折叠;Install/Quick Start/Requirements 不得折叠。audit 脚本路径依赖技能目录。其它细节(安装命令、收费、平台)暂未提供。