SuperAPI AI 工具集

rfc-writer

设计与创作

查看项目

更新于 10-16 01:19

技能介绍

用途:在代码库中撰写并维护轻量级 RFC(编号 Markdown 设计提案),在实现前或实现中记录问题、代码现状、已锁定决策及理由、明确不在范围内的内容。设计历史由单个 INDEX.md 以表格形式汇总,便于整体浏览。

主要能力:决策分级——LOCKED(已定,冲突时中止并上报,由作者裁定)、ASSUMED(认为正确但非关键,若证伪可偏离并记录)、OPEN(有意交给实现决定并记录理由);分级须诚实,多数行应为 ASSUMED,仅在其他工作会因反转失效时用 LOCKED,OPEN 行表示作者已考虑并主动委托,缺行则等于未记录该问题。索引一句话只负责指引读者打开哪份 RFC,写问题与答案形态,目标约 200 字符、上限 300 字符,不写机制、备选与数字,也不记录发布时间、阶段进度或修订历史。执行阶段可提出新决策行,决策表仅可追加,被取代的行保留并标注取代它的行;不得为迎合实现而修改 RFC 正文;被采纳的行需引用来源,如 logs/T-0142.md (D-3, attempt 2)。

使用方式:脚本位于 skills/rfc-writer/scripts/rfc_index.py,可执行: python3 scripts/rfc_index.py check python3 scripts/rfc_index.py next python3 scripts/rfc_index.py new "Title" 除 new 外为只读操作;仓库非当前目录时可加 --root DIR(可放在子命令前后)。流程、文档结构与文风见 references/workflows.md、references/authoring.md;撰写前可参考 references/rfc-template.md、references/index-template.md。

适用场景:需要撰写 RFC、设计提案、设计文档、技术规格或架构提案,或记录某决策及其被击败的备选方案时。

限制与关联:脚本不判定决策等级、索引措辞及执行与文档冲突时的处置,这些需人工决定。flag-dont-flip 负责按分级执行 RFC、维护任务日志并提议新行;altitude-docs 为用户文档;self-audit 用于合并前的对抗性审查;keep-a-changelog 记录已发布内容。其他未提供的细节暂未说明。