SuperAPI AI 工具集

arkweb-design-doc

写作与研究

查看项目

更新于 10-16 03:11

技能介绍

用途:基于 brainstorm 阶段确认的方案与代码分析结果,按标准模板输出正式设计文档。支持两种运行模式:Subagent 模式(由 arkweb-architect 调用,方案与代码分析已在 task 描述中提供)和交互模式(主 session 直接调用,用户确认方案后生成并请用户审阅)。

主要能力:Phase 4 产出两份文档——requirement.md(需求基线评审,模板 assets/templates/requirement.md)与 design.md(架构设计,模板 assets/templates/design.md)。核心原则是单一方案文档,只体现最终确认方案,不做 A/B/C 对比;降级或回退路径作为异常处理章节说明。文档类型还涉及需求导入检查、功能设计说明书、API Spec 等模板。

使用方式:流程分读取参考资料、分析项选择、自检、输出四步。Step 1 读取兼容性、架构、竞品、设备矩阵、代码索引与代码分析等参考文档,输出候选子系统(1~3)、候选部件(3~8)、关键 API(5~20),证据包写入临时目录。Step 2 交互模式下先列模板分析项清单,由用户回复序号选择需分析章节,未选中项标记“不涉及”;Subagent 模式由 task 描述的分析项范围字段指定,未指定则默认全部分析。生成前必须先读取模板文件,严格按模板章节结构与中文标题填充。产出目录为 DOCS_REPO/docs/features/feature-name/,文件名为 {date}-{feature}-requirement.md 与 {date}-{feature}-design.md,语言中文,图表使用 ASCII 格式,文档顶部不放日期、版本、状态、变更说明等元数据块。

适用场景:ArkWeb 相关需求的设计文档撰写、需求基线评审、功能设计输出与 API Spec 编写。

限制:需依赖指定的 DOCS_REPO 目录结构、模板与参考资料路径;模板合规检查以 Python 清单形式给出;具体校验执行细节、模板实际文件内容、环境与依赖版本暂未提供。