SuperAPI AI 工具集

update-readme

写作与研究

查看项目

更新于 10-15 17:20

技能介绍

用途:在 README 需要结构性刷新时使用,把它整理成面向新读者的索引式文档。使用前建议先运行 Skill(sanctum:git-workspace-review) 获取仓库上下文与差异。不适用于更新内联文档(用 doc-updates)或整合临时报告(用 doc-consolidation)。

主要流程:第1步语言审计,确认 pwd、git status -sb 与基线分支,依据清单文件和文件数量判断主次语言。第2步范例调研,按语言用网络搜索找高质量 README,每种语言记录2至3个范例及理由并保留引用。第3步大纲对齐,README 应以项目是什么、如何安装、可扫描的单元表格开头,其余内容改为链接;深度、FAQ、路线图、变更日志、备用安装方式等外链到独立页面,目标约150至400行正文加索引表。第4步应用编辑,遵循 markdown 格式约定(80字符换行、ATX 标题、列表前空行、长 URL 用引用式链接),优先删除与链接而非内联。第4.5步 AI 味检测,运行 Skill(scribe:slop-detector) --target README.md,检测套话、营销词与结构痕迹;分数超过2.0时可按 Skill(scribe:doc-generator) 原则修正,或用 Agent(scribe:doc-editor) --target README.md。第5步验证与报告,复查清晰度与链接,运行 git diff README.md 并汇总语言、范例来源、结构决策与后续待办。

退出标准:所有 TodoWrite 项完成;README 呈索引形态;无章节重复 book/ 或 docs/ 页面;删除内容应落到外链页面而非丢弃;引用内部文档与外部范例;保留研究记录以便复现。

限制:资料未提供具体安装命令、收费与价格等信息。故障排除提及 make docs-sync-check 校验能力文档与插件注册是否一致,以及检查依赖与相对链接。