SuperAPI AI 工具集

design-document

写作与研究

查看项目

更新于 10-15 16:47

技能介绍

用途:为技术设计文档的撰写与评审提供统一规范,帮助组织背景、目标、方案与测试等章节。

主要内容分四部分。第一部分背景/问题陈述:描述现有系统或模块的局限与痛点,列出触发设计的场景、指标或事故案例;说明影响范围,包括受影响的模块、微服务、API、数据存储与第三方依赖,以及对性能、可靠性、成本、可维护性和前后兼容性的潜在影响;列出合规、安全、性能、资源等约束和外部依赖。第二部分设计目标:按 Must/Should/Could 优先级列出功能目标;非功能目标覆盖性能(吞吐、延迟、并发、资源占用)、可扩展性、可维护性、可测试性、可观测性和可靠性(容错、高可用、降级、回滚);约束目标包括向后兼容、API 稳定性和安全合规要求。第三部分技术设计:用 Mermaid 画高层次组件图与数据/控制流;关键业务流程、异常流程、重试补偿的详细流程图及触发条件;线程/并发模型(线程生命周期、线程间通信、并发时序图);核心类与数据结构(类图、关键字段、生命周期、线程安全策略);关键算法或协议(伪代码、状态机、协议状态转换图);错误处理与恢复(错误分类、异常栈、重试、降级、监控指标与告警);部署与运维(配置项、热更新、灰度与回滚、CI/CD、容器、Service Mesh、Kubernetes 资源)。第四部分单元测试:测试范围与目标、环境与工具(如 Google Test/Mock 版本、桩与假件)、测试场景与用例表(用例编号、场景、输入、预期输出/行为、Mock 依赖,如正常推送、缓冲满、并发推送、flush 清空)、边界与异常测试(空输入、非法输入、极限容量、故障注入)、可选性能基准测试。

限制与注意事项:不包含项目管理信息(估算、排期、里程碑、甘特图);代码示例须遵循团队 C++ 编码规范(见 skills/project-knowledge/);测试用例命名采用 <Module><Function><Number> 以支持 CI 覆盖率追踪。文档未提供安装命令或具体代码实现,相关细节暂未提供。