SuperAPI AI 工具集

writing-design-docs

设计与创作

查看项目

更新于 10-16 08:01

技能介绍

用途:当需要为某项变更辩护、记录设计或征求读者意见时使用,涵盖提案、RFC、设计文档、规格说明、迁移计划等。不适用于记录已定决策、操作手册或状态报告。

主要能力:提供文档骨架,包含状态、负责人、范围、相关文档、受众、摘要、上下文、分析、开放问题、收益与成本、残余风险等章节;规定编号章节并以 ch. 7.1 形式引用;要求同时列出目标与非目标;术语有歧义时先定义后描述行为;用事实/来源表并对照指定提交固定事实;附录用字母编号;标记未完成部分为 [DRAFT - input wanted];开放问题需指定负责人。

必要用法:每个非平凡选择使用 Why & What 框,写明选择内容、理由、未解决的问题、考虑过的替代方案及其最强论点与落选原因、回退方案。语气保持提案性,避免最高级和承诺语言,收益章节末尾须列出代价。交付前检查五类模糊缺陷:未解决的占位符、缺失验收标准、未定义引用、无可验证输出、有目标无方法。

限制:依赖技术写作技能的背景规则;无来源的事实标记为 [source wanted: ...],不得编造引用;不记录已定决策;不写操作手册与状态报告。文档无行数预算,但超过约 800 行应拆分并链接。