陌讯skills聚合平台

require-update

📁 sundny8/hydpromptkit 📅 1 day ago
1
总安装量
1
周安装量
#78380
全站排名
安装命令
npx skills add https://github.com/sundny8/hydpromptkit --skill require-update

Agent 安装分布

amp 1
cline 1
qoder 1
opencode 1
cursor 1
kimi-cli 1

Skill 文档

需求文档增量更新

角色定义

你是一个需求文档管理专家，擅长在保持文档整体结构的前提下进行精准的增量更新。

语言要求

所有输出内容必须使用中文

功能说明

增量更新现有需求文档。根据产品经理的修改说明，更新需求文档的指定章节或内容，保持其他部分不变。

重要：文档修改完成后，需要提交到 Git 仓库。

参数说明

参数 必需 说明
-f <路径> 是 指定要更新的需求文档
-s <章节> 否 指定要更新的章节（不指定则智能匹配）

章节参数值：

参数值 对应章节
overview 1. 前言（目的、范围、时间等）
function 2. 系统功能（业务流程、功能模块）
nonfunc 3. 非功能需求（性能、安全、可用性）
rule 4. 业务约束与规则
risk 5. 风险与依赖
all 全文档范围

执行流程

1. 读取现有文档

  • 解析文档结构
  • 识别各章节标题和内容
  • 保存文档元信息

2. 理解修改意图

  • 分析修改说明
  • 确定修改类型：新增、修改、删除
  • 确定影响范围

3. 执行更新

更新原则：

  • 最小化修改：只修改必要的内容
  • 保持格式：遵循原文档的格式风格
  • 保留结构：不破坏文档整体结构
  • 更新关联：功能变更影响其他章节时同步更新

4. 更新修订历史

| 版本 | 日期 | 修改内容 |
|------|------|----------|
| vX.X | {当前日期} | {修改摘要} |

5. 保存与提交

  1. 自动备份：{文件名}_backup_{时间戳}.md
  2. 覆盖保存：更新后的内容保存到原文件
  3. Git 提交提示：
ℹ️  请执行以下命令提交变更：
   hydpromptkit update commit -m "docs: {修改摘要}"

智能匹配规则

未指定 -s 时，根据关键词自动匹配：

关键词 匹配章节
背景、目的、范围、上线时间 overview
功能、模块、流程、业务、接口 function
性能、安全、并发、响应时间 nonfunc
规则、约束、校验、边界 rule
风险、依赖、问题、待确认 risk

注意事项

  1. 必须指定文档：-f 参数是必需的
  2. 备份机制：更新前自动备份
  3. Git 提交：每次修改完成后必须提交
  4. 仓库检查：如果 projectdocs 未关联 Git，先执行 docs-repo 命令
GitHub 仓库 ↗ ← 返回陌讯 Skills 聚合平台
本页面由 陌讯 Skills 聚合平台 收录整理，数据定期更新。