SuperAPI AI 工具集

documentation

写作与研究

查看项目

更新于 11-05 07:49

技能介绍

该技能用于维护「AI 仓库测试框架指南」这一文档仓库中的内容,覆盖新增、更新和审阅九章编号内容(01–09)。

用途与流程:开始编辑前先阅读 AGENTS.md,理解双读者结构、文档映射表、配套材料、不变量与已知易错点;借助文档映射表和配套材料表确定任务对应的文件,避免把内容写进错误的文件;在全部九章中检索该主题是否已有覆盖,若已存在则改为链接引用,不重复撰写。

读者分层与写作风格:01–02 章使用通俗语言、不含实现细节,面向非技术读者;03–09 章使用精确的技术语言,假定读者具备工程背景。行文要求直接陈述,不使用填充语和元叙述,句子简短,删除无意义内容;图表使用 Mermaid 而非 ASCII 艺术;01–02 章避免流行术语与行话。

提示词管理:提示词只应放在技能参考文件中;修改提示词需编辑对应技能参考文件,并在同一次变更中复核配对章节对提示词覆盖内容与产出的叙述是否仍然一致。提示词应视为可执行内容,智能体按提示词执行应无需额外说明即可产出正确结果;不得为方便而把提示词复制回章节,以免产生漂移。

完成前检查:确认系列中无重复内容、所有交叉链接准确指向正确文件与章节、双读者结构得到保持。

变更记录与版本:实质性修改后需在相应变更日志中记录,并更新匹配版本,指南与各技能分别版本化。指南变更(01–09 章、guide/README.md、guide/READING.md、guide/FAQ.md)需更新 guide/CHANGELOG.md 并更新 guide/README.md 中的 Current 行。技能变更(.agents/skills/<skill>/ 下任意文件)需同时更新该技能的 CHANGELOG.md 与 SKILL.md front matter 中的 metadata.version,两者缺一即不同步;技能 README.md 通过链接指向 CHANGELOG.md,无需更新。若变更涉及 harness-setup 或 harness-inspect,还需更新 harness-plugin/.claude-plugin/plugin.json 与 harness-plugin/.cursor-plugin/plugin.json 中的版本,因为这两个技能目录是指向 harness-plugin/skills/ 的符号链接,已安装插件依赖该版本字段判断更新。

版本级别:补丁(x.y.Z)用于拼写、链接修正及不改变行为或内容的文档更新,除非明确要求否则并入下个次要版本;次要(x.Y(.0))用于新增章节、提示词、来源、资源或行为,是多数实质性修改的默认级别;主要(X.0(.0))用于结构性变更,如增删章节或阶段、破坏输出格式、改变读者或范围。变更日志条目置于顶部并按 Added/Changed/Removed/Fixed 分类,每条注明涉及文件并链接相关章节或资源;README 版本行与最新变更日志条目须一致。跨指南与技能的变更需分别在两侧记录并互相交叉引用。

技能目录内引用规则:对指南的引用使用绝对 HTTPS URL,因为符号链接到 ~/.claude/skills/ 时相对路径会失效;技能之间的引用不提供链接(相对或绝对均不可),仅以名称提及,因为用户可能只安装其中一个技能且符号链接结构未知。内部 documentation 与 guide-review 技能未做符号链接,可使用相对路径。

适用场景:维护该指南仓库的章节内容、提示词参考文件、变更日志与版本号,以及审阅文档一致性与结构。限制:资料未提供该技能的安装命令、运行环境、收费或价格信息,均暂未提供。