SuperAPI AI 工具集

note-it

通用与其它

查看项目

更新于 10-16 08:35

技能介绍

note-it 用于在完成一个 Issue 的实现与 /review-it 审查修复之后,生成一份实现笔记,记录实现如何偏离或解释规格说明。触发时机:/goal 实现与 /review-it 都完成后、用户说出“记录笔记”“implementation notes”“note-it”“/note-it”时、/ship-it 之前的最终检查点,或任何需要记录设计理由的时刻。

主要工作:从上下文(分支名、/goal 目标或用户输入)确定 Issue 编号;对照 Issue 规格/PRD 检查实现;生成 HTML 笔记文件到 docs/issue#XXXX.html;向用户呈现摘要。

笔记必须覆盖四类内容,某类无内容时写“None”并简短说明:设计决策(规格含糊或未提及时的选择、理由)、偏差(有意偏离规格之处,对比规格与实现及原因)、取舍(考虑过的可行替代方案及优劣、选择理由)、待确认问题(不确定的假设、需用户验证的内容、可能的后续工作)。输出格式为 HTML,位置 docs/,文件名为 issue#XXXX.html,例如 issue#0042.html。资料提供了需使用的 HTML 模板结构,包含标题、元信息、四个分类区块与条目样式,以及一个示例条目。

确定 Issue 编号的规则:用户直接给出(如 /note-it #42)则用该编号;分支名为 feat/issue-42-* 或 fix/issue-42-* 时提取 42;上次 /goal 目标是 #42 时用 42;否则询问用户使用哪个 Issue 编号。

边界情况:找不到 Issue 编号时询问用户;docs/ 目录不存在时自动创建;笔记文件已存在时询问“更新现有笔记还是覆盖”,默认更新(追加新条目);没有偏差或待确认问题时写“None — implementation followed the spec as written.”;找不到规格/PRD 文件时在待确认问题中注明“No PRD found at tasks/prd-*.md — verify against original requirements.”。保存前检查清单:已确定 Issue 编号、四个分类均已审阅(即使为“None”)、设计决策说明理由而非仅描述做法、偏差清楚对比规格与实现、取舍提及具体考虑过的替代方案、待确认问题可执行、HTML 格式正确可渲染。

限制:资料未提供安装命令、定价、平台支持、模型依赖或性能数据,暂未提供。