SuperAPI AI 工具集

dev-rfc

写作与研究

查看项目

更新于 10-16 03:46

技能介绍

用途:为软件项目撰写结构化的 RFC、技术提案与架构文档。既用于构建前的利益相关方对齐(应做什么、为什么),也用于帮助工程师理解已建成系统如何运作,多数真实提案是两者混合,技能帮助按情境选择合适章节。

主要能力:提供三种结构模板(见 references/template.md,资料未给出模板正文):RFC 用于构建前对齐,关注摘要、方案对比、服务 SLA、可观测性与发布计划;架构文档用于记录已建成系统,关注图表、源码树、数据流与设计理念;一页纸用于小于一周的小改动,含问题、方案、发布,约 20 行。支持把已存在系统的改动以 RFC 为骨架,并在详细设计中加入前后架构图,用 [NEW]、[CHANGED] 标记组件。文件放置建议:正式 RFC 放 docs/rfcs/RFC-NNN-title.md,项目架构文档放仓库根 ARCHITECTURE.md,子系统文档放 docs/design/ 或代码旁;未指定时需询问。

使用方式:先与用户确认模式(RFC、架构文档、一页纸),再了解项目约束、干系人、替代方案;然后按模板起草,再用清单复查。可选评审流程用 Bun(或 Node 22+ 加 --experimental-strip-types)运行脚本启动本地评审服务:bun run "$(dirname "$SKILL_PATH")/scripts/generate_review.ts" <doc-path> --title "<project name>",默认监听 localhost:3118,反馈自动保存到 <doc-dir>/.rfc-review/feedback.json;读取状态用 cat <doc-dir>/.rfc-review/feedback.json。也可用 --live 进入逐节协作模式,或 --static 作为静态回退。

适用场景:规划新系统或重大改动、记录现有系统、提出对现有系统的变更、小范围改动。限制:具体模板内容、价格与平台支持等信息暂未提供;评审脚本依赖 Bun 或较新 Node,端口冲突时需回退静态模式。