前端技术文档 -如何让AI 快速生成模版

0 阅读5分钟
提示词模板

请根据以下需求文档,结合现有代码项目,输出一份完整的前端开发技术方案文档:

**需求文档**:<需求文档路径或内容>
**代码项目**:<项目根目录路径>

**要求**:

1. 先阅读需求文档,再深入分析代码项目的技术栈、目录结构、现有模式(组件风格、API 调用方式、状态管理、权限控制、路由结构等)
2. 将需求中的每个功能点精确映射到代码项目中的具体文件路径
3. 技术方案需包含以下内容:
   - 需求概述与链路梳理
   - 影响范围(精确到文件级)
   - 整体架构设计(新增的共享模块、组件层级关系)
   - 共享模块详细设计(Hook / 组件 / 工具函数的 API 设计与核心算法)
   - API 接口设计(前端请求路径、参数、响应结构)
   - 各模块详细实现方案(模板结构变更、操作 出代码片段)
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 三、整体架构    │ 新增 4 个共享模块(2 Ho 构(页面→组件→Hook→API)                │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 四、共享模块设  │ useRevokeWindow(窗口计算)、useDeletePermission(删除判断)、RevokeConfirmDialog(确认弹窗  │
│ 计              │ )、revoke.js(工具函数)的完整 API 设计与算法                                               │
├─────────────────┼─────────────────────────────────────────────────────────────────┤
ermi 指令方案                                                            │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 八、状态管理    │ 页面级响应式状态设计,不新增 Vuex 模块                                                       │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 九、异常处理    │ PRD 全部 12 个异常场景的前端处理方案 + 防重复提交、竞态控制代码                              │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 十、样式方案    │ 行底色分级(urgent 红底 / expired 灰底)、撤回标记标签、只读字段灰底                         │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 十一、路由变更  │ 不新增页面,复用 5 条现有路由                                                                │
├─────────────────┼─────────────────────────────────────────────────────────────────┤
 26 人天,含推荐开发顺序                                                │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 十四、设计决策  │ 6 项关键决策 + 5 项风险缓解措施,含 done.vue 拆分子组件建议                                  │
│ 与风险          │                                                                                              │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 十五、测试要点  │ 功能测试矩阵(16 项)+ 边界测试(5 项)                                                      │
├─────────────────┼──────────────────────────────────────────────────────────────────────────────────────────────┤
│ 十六、上线      │ 8 项上线前确认清单                                                                           │
│ Checklist       │                                                                                              │
├─────────────────┼─────────────────────────────────────────────────────────────────┤
│ 附录 A          │ 全部话术速查表(12 条)                                                                      │
├─────────────────┼─────────────────────────────────────────────────────────────────┤
│ 附录 B          │ 文件变更清单(13 个文件,4 新增 + 9 修改)                                                   │
└─────────────────┴──────────────────────────────────────────────────────────────────────────────────────────────┘

所有设计均基于对现有代码的分析,复用了项目codebase. I completed and saved the full document to the project root. Next step is for you to review it. (disable recaps in /config)

❯ 如果后期还想生成这的技术文档,应该输出怎么样的提示词呢

  Thought for 3s

基于这次生成技术文档的经验,我总结了一个可复用的提示词模板:

---
提示词模板

请根据以下需求文档,结合现有代码项目,输出 :

**需求文档**:<需求文档路径或内容>
**代码项目**:<项目根目录路径>
**需求文档**:<需求文档路径或内容>
**代码项目**:<项目根目录路径>

**要求**:

   - 整体架构设计(新增的共享模块、组件层级关系)
   - 共享模块详细设计(Hook / 组件 / 工具函数的 API 设计与核心算法)
   - API 接口设计(前端请求路径、参数、响应结构)
   - 各模块详细实现方案(模板结构变更、操作列调整、弹窗设计、脚本逻辑,给出代码片段)
   - 权限控制方案
   - 状态管理方案
   - 异常处理(覆盖所有边界场景)
   - 样式方案
   - 接口调用时序图

   - 文件变更清单

4. 所有设计决策必须与现有代码风格和模式保持一致
5. 话术文案严格按需求文档原文
6. 标注哪些是本期不做的内容(如需求文档中明确排除的部分)

**输出格式**:Markdown,保存到 <输出路径>

---
简化版(日常使用)

如果觉得上面的太长,日常可以用这个精简版:


- 每个功能点映射到具体文件
- 包含架构设计、API 设计、详细实现方案(附代码片段)、异常处理、排期估时
- 与现有代码风格保持一致
- 输出为 Markdown 保存到 <路径>

---
关键要素拆解

一个好的提示词需要包含这几个要素:

┌────────────────┬────────────────────────────┬──────────────────────────────────┐
│      要素      │            作用            │            缺少会怎样            │
├────────────────┼────────────────────────────┼──────────────────────────────────┤
│ 需求文档路径   │ 让 AI 读取完整需求         │ 凭空臆造需求细节                 │
├────────────────┼──────────────────────────────────┤
│ 代码项目路径   │ 让 AI 分析现有架构和模式   │ 方案脱离实际项目,变成通用模板   │
├────────────────┼──────────────────────────────────┤
│ 映射到具体文件 │ 确保方案可落地             │ 只输出抽象设计,开发无法直接使用 │
├────────────────┼──────────────────────────────────┤
│ 保持一致性     │ 复用现有模式而非引入新范式 │ 方案与项目风格割裂               │
├────────────────┼──────────────────────────────────┤
│ 附代码片段     │ 给出可参考的实现           │ 只有文字描述,开发还得从零写     │
├────────────────┼────────────────────────────┼──────────────────────────────────┤
│ 排期估时       │ 帮助项目管理               │ 缺少工时评估                     │
├────────────────┼────────────────────────────┼──────────────────────────────────┤
│ 输出路径       │ 指定保存位置               │ 输出到聊天窗口,不方便分享       │
└────────────────┴──────────────────────────────────┘

---
进阶变体

针对不同场景,可以微调提示词:

侧重方案设计(不需要太细的代码):
... 重点输出架构设计、模块拆分、接口设计,代码片段仅给关键逻辑 ...

侧重可直接编码(需要详细实现):
... 每个页面的模板、脚本、样式给出完整可运行的代码片段,而非伪代码 ...

侧重评审讨论(需要决策分析):
... 对每个关键设计决策列出 2-3 个备选方案的...

侧重后端协作(需要接口对齐):
... 重点输出 API 接口设计(含完整的请求/响应结构示例),方便与后端对齐接口文档 ...