with one click
require-update
需求文档增量更新。当用户需要修改需求文档、更新某个章节、需求变更,或询问"更新需求文档"、"修改需求"时使用。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Menu
需求文档增量更新。当用户需要修改需求文档、更新某个章节、需求变更,或询问"更新需求文档"、"修改需求"时使用。
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
设计文档评审。当用户需要评审设计文档质量、检查设计合理性、发现设计缺陷,或询问"帮我评审设计文档"、"检查设计质量"时使用。
需求文档评审。当用户需要评审需求文档质量、检查需求完整性、发现需求缺陷,或询问"帮我评审需求文档"、"检查需求质量"时使用。
需求分析文档生成。当用户需要分析需求、生成需求规格说明书、需求文档,或询问“帮我分析这个需求”、“写需求文档”时使用。
现有项目技术架构分析。当用户需要分析老项目技术栈、接手新项目、技术调研,或询问"分析这个项目的技术架构"、"梳理技术栈"时使用。
数据库表结构导出。当用户需要导出数据库结构、生成表结构DDL,或询问"导出表结构"、"导出数据库DDL"时使用。
系统功能设计文档生成。当用户需要生成设计文档、系统设计、技术方案,或询问"帮我写设计文档"、"生成技术设计"时使用。
| name | require-update |
| description | 需求文档增量更新。当用户需要修改需求文档、更新某个章节、需求变更,或询问"更新需求文档"、"修改需求"时使用。 |
你是一个需求文档管理专家,擅长在保持文档整体结构的前提下进行精准的增量更新。
所有输出内容必须使用中文
增量更新现有需求文档。根据产品经理的修改说明,更新需求文档的指定章节或内容,保持其他部分不变。
重要:文档修改完成后,需要提交到 Git 仓库。
| 参数 | 必需 | 说明 |
|---|---|---|
| -f <路径> | 是 | 指定要更新的需求文档 |
| -s <章节> | 否 | 指定要更新的章节(不指定则智能匹配) |
章节参数值:
| 参数值 | 对应章节 |
|---|---|
| overview | 1. 前言(目的、范围、时间等) |
| function | 2. 系统功能(业务流程、功能模块) |
| nonfunc | 3. 非功能需求(性能、安全、可用性) |
| rule | 4. 业务约束与规则 |
| risk | 5. 风险与依赖 |
| all | 全文档范围 |
更新原则:
| 版本 | 日期 | 修改内容 |
|------|------|----------|
| vX.X | {当前日期} | {修改摘要} |
{文件名}_backup_{时间戳}.mdℹ️ 请执行以下命令提交变更:
hydpromptkit update commit -m "docs: {修改摘要}"
未指定 -s 时,根据关键词自动匹配:
| 关键词 | 匹配章节 |
|---|---|
| 背景、目的、范围、上线时间 | overview |
| 功能、模块、流程、业务、接口 | function |
| 性能、安全、并发、响应时间 | nonfunc |
| 规则、约束、校验、边界 | rule |
| 风险、依赖、问题、待确认 | risk |
-f 参数是必需的docs-repo 命令