技术方案文档生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_1d9594a8/tech-doc-generator
技能介绍
先解决这些文档痛点
技术方案文档常见两类问题:一类堆砌空泛概念,读者看完仍不知道怎么落地;另一类只写零散片段,架构、接口、风险各说各的,评审时还要反复补内容。真正能直接用的方案,需要同时讲清“为什么这么设计”“具体怎么做”“出问题怎么办”。
技能如何生成方案
它会基于你提供的业务需求或功能描述,按固定结构输出完整 Markdown 文档。默认章节覆盖 背景与目标、整体架构、详细设计、实现路径、风险与应对、兼容性与迁移。其中详细设计会展开接口定义、数据模型与核心流程,不必再手动补框架。
写作时遵循几个明确原则:每个设计点都配套具体实现路径,例如接口定义会写清 请求/响应 字段和 错误码;遇到业务约束(比如“不能修改原表结构”)会直接贴合,不会给出违背前提的方案;能用表格、流程图描述的,就不用大段文字;同时主动前置 技术风险 和 降级方案,不等到评审才暴露问题。风格面向研发,保持专业口语化,避免生硬书面套话。
适用边界与注意点
它适合用在 新项目、新功能、系统重构、接口规范、技术选型 等场景,前提是你能提供相对明确的业务目标和约束条件。它产出的是结构化方案骨架与设计要点,不能替代实际预研中的性能压测或方案验证,也不能直接生成可运行的业务代码。若需求描述过于模糊,生成的章节可能缺少针对性,需要补充细节后再调整。
使用场景
- 负责核心系统重构的后端工程师在动手前,需要产出包含数据迁移与兼容性设计的完整技术方案用于团队评审。
- 开放平台负责人在引入第三方接入前,需快速输出包含网关鉴权、限流策略与监控表结构的接口规范文档。
- 技术负责人面对新旧框架替换,需要整理技术选型对比分析,并给出明确的风险识别与降级应对方案。
适合人员
- 后端工程师,诉求是把业务需求快速转化为包含接口和数据模型的结构化设计文档,避免评审时被反复打断。
- 技术架构师,诉求是在系统重构或新项目启动时,输出逻辑清晰、风险前置且具备落地路径的架构方案。
- 前端或全栈开发者,诉求是在接入新功能或跨团队联调时,获取清晰的接口定义与错误码规范以降低沟通成本。