Skills included: - Review (6): rr, rp, rf, rd, ru, rt - Write (5): wp, wf, wd, wu, wt - Modify (6): mr, mp, mf, md, mu, mt - Utils (2): iter, up Supports complete document lifecycle: RequirementsDoc → PRD → FeatureSummary → DevelopmentPlan → UIDesign → tasks Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
96 lines
2.3 KiB
Markdown
96 lines
2.3 KiB
Markdown
---
|
||
name: mr
|
||
description: 增量修改 RequirementsDoc.md,根据用户指令在现有内容基础上更新需求文档。
|
||
---
|
||
|
||
# Modify RequirementsDoc
|
||
|
||
当用户调用 `/mr` 时,执行以下步骤:
|
||
|
||
## 1. 读取目标文档
|
||
|
||
读取 `doc/RequirementsDoc.md` 文件。
|
||
|
||
如果文件不存在,提示用户:
|
||
> RequirementsDoc.md 不存在,请先使用人工方式创建需求文档。
|
||
|
||
## 2. 获取修改指令
|
||
|
||
向用户确认修改内容。用户应提供以下信息之一:
|
||
|
||
- 具体的修改描述(如"在第3节增加性能需求")
|
||
- 评审报告路径(如 `doc/review-RequirementsDoc-claude.md`)
|
||
- 直接的修改内容
|
||
|
||
如果用户未提供修改指令,询问:
|
||
> 请说明需要修改的内容,或提供评审报告路径。
|
||
|
||
## 3. 修改原则
|
||
|
||
### 3.1 增量修改
|
||
- 保留原有内容结构和格式
|
||
- 仅修改/新增指定部分
|
||
- 不删除未明确要求删除的内容
|
||
|
||
### 3.2 新增内容标记
|
||
|
||
对于新增的段落或章节,使用 HTML 注释标记:
|
||
|
||
```markdown
|
||
<!-- NEW START -->
|
||
新增内容...
|
||
<!-- NEW END -->
|
||
```
|
||
|
||
对于行内新增,使用:
|
||
```markdown
|
||
原有内容 <!-- NEW --> 新增内容
|
||
```
|
||
|
||
### 3.3 修改内容标记
|
||
|
||
对于修改的内容,保留原文作为注释:
|
||
|
||
```markdown
|
||
<!-- MODIFIED: 原内容为 "xxx" -->
|
||
修改后的内容
|
||
```
|
||
|
||
## 4. 执行修改
|
||
|
||
按照用户指令修改文档:
|
||
|
||
1. 定位到需要修改的位置
|
||
2. 执行增量修改
|
||
3. 添加相应的标记
|
||
4. 保持文档格式一致性
|
||
|
||
## 5. 保存并验证
|
||
|
||
1. 保存修改后的文档到 `doc/RequirementsDoc.md`
|
||
2. 使用 git diff 展示变更内容
|
||
3. 向用户确认修改是否符合预期
|
||
|
||
## 6. 输出摘要
|
||
|
||
向用户展示修改摘要:
|
||
- 修改位置(章节/行号)
|
||
- 修改类型(新增/修改/删除)
|
||
- 修改内容概要
|
||
|
||
---
|
||
|
||
## 注意事项
|
||
|
||
- RequirementsDoc 是文档链源头,修改会影响所有下游文档
|
||
- 修改前确认用户意图,避免误改
|
||
- 保持现有文档风格(标题层级、表格格式、列表样式)
|
||
- 重大修改建议先运行 `/rr` 评审确认影响范围
|
||
- 修改完成后,建议用户检查下游文档是否需要同步更新
|
||
|
||
## 标记清理
|
||
|
||
当用户确认修改无误后,可手动删除 `<!-- NEW -->` 和 `<!-- MODIFIED -->` 标记,或保留作为变更历史参考。
|
||
|
||
通过 git 可追溯完整修改历史。
|