SuperAPI AI 工具集

code-design-docs-spec

设计与创作

查看项目

更新于 10-16 09:45

技能介绍

用途:针对软件设计文档编写与维护,提供架构设计、功能需求规格、测试规格三类规范。按变更内容选择对应规范:涉及架构、接口、技术决策用 arch-spec;涉及用户可见功能与需求范围用 prd-spec;涉及测试策略、测试边界与测试用例用 test-spec。

主要能力:每套规范包含触发条件判断、文档结构、写作规则和自检清单,并统一使用规则强度标记(REQUIRED 必须遵守、PROHIBITED 明确禁止、OPTIONAL 视情况使用)。所有设计文档统一标注状态:> Status: draft | active。draft 转为 active 需自检清单全部通过;废弃文档如有替代则移入 deprecated/ 文件夹并在文件头部添加 > Superseded by: [链接],无替代则直接删除。

使用方式:先判断文档类型,再读取对应规范文件(架构设计读 references/arch-spec.md,功能需求读 references/prd-spec.md,测试规格读 references/test-spec.md),然后按规范中的 Agent 执行工作流操作。目录结构按 docs/design/ 下分 arch、prd、test 三类,各含 00-overview.md、编号文档、deprecated/ 与 reference/。

限制:禁止跳过触发条件判断、忽略自检清单、使用模糊语言(如“可能”“大概”“视情况而定”)、复制其他文档内容(应使用链接引用)。其他平台、价格、具体调用命令等资料暂未提供。