SuperAPI AI 工具集

write-feature-docs

通用与其它

查看项目

更新于 10-16 07:21

技能介绍

用途:为新 Warp 功能起草完整文档页。技能读取功能规格(PRODUCT.md 为主,TECH.md 为辅),自行通过代码库验证技术声明,依次与工程师确认内容设计计划和提纲,最后生成完整 MDX 草稿,并在 warpdotdev/docs 提交草稿 PR、标记文档团队审阅。工程师只需确认无法从规格与代码核实的内容。

主要能力:定位并阅读规格文件,规格 ID 可为 Linear 票号(如 APP-1234)、GitHub issue(gh-4567)或 kebab-case 功能名。TECH.md 中的内部实现细节(数据库结构、内部服务名、私有 API、机密架构)须先向工程师确认可否公开,未获确认不得写入草稿。用 GitHub CLI 验证功能开关名、UI 文案、Settings 路径、CLI 命令或快捷键、相关功能与负责人;无法核实的标注为 [UNVERIFIED]。

使用方式:分步确认。先填写内容设计计划模板并等待确认(读者与 JTBD),再展示提纲并等待确认;两者顺序不可合并。随后按内容类型模板(feature-doc、conceptual、procedural、reference、troubleshooting、quickstart、guide-page)生成 MDX,若 computer_use 可用则尝试按“预测→截图→校验→重试一次”协议补截图。

限制:需要工程师在场确认可发布内容,无无人值守路径;未发布功能、截图质量不达标或无法核实的路径保留 [TODO] 占位;规格 ID 需先做字符校验,非法则跳过查询并使用 [TODO: tag spec author] 占位。