2.8 KiB
2.8 KiB
name, description
| name | description |
|---|---|
| changelog-template | 变更记录模板。当 Product Spec 发生迭代变更时,按照此模板格式记录变更历史,输出为 Product-Spec-CHANGELOG.md 文件。 |
变更记录模板
本模板用于记录 Product Spec 的迭代变更历史。
文件命名
Product-Spec-CHANGELOG.md
模板格式
# 变更记录
## [v1.2] - YYYY-MM-DD
### 新增
- <新增的功能或内容>
### 修改
- <修改的功能或内容>
### 删除
- <删除的功能或内容>
---
## [v1.1] - YYYY-MM-DD
### 新增
- <新增的功能或内容>
---
## [v1.0] - YYYY-MM-DD
- 初始版本
记录规则
- 版本号递增:每次迭代 +0.1(如 v1.0 → v1.1 → v1.2)
- 日期自动填充:使用当天日期,格式 YYYY-MM-DD
- 变更描述:根据对话内容自动生成,简明扼要
- 分类记录:新增、修改、删除分开写,没有的分类不写
- 只记录实际改动:没改的部分不记录
- 新增控件要写位置:涉及 UI 变更时,说明控件放在哪里
完整示例
以下是「剧本分镜生成器」的变更记录示例,供参考:
# 变更记录
## [v1.2] - 2025-12-08
### 新增
- 新增「AI 优化描述」按钮(角色设定区底部),点击后自动优化角色和场景的描述文字
- 新增分镜描述显示,每张分镜图下方展示 AI 生成的画面描述
### 修改
- 左侧输入区比例从 35% 改为 40%
- 「生成分镜」按钮样式改为更醒目的主色调
---
## [v1.1] - 2025-12-05
### 新增
- 新增「场景设定」功能区(角色设定区下方),用户可上传场景参考图建立视觉档案
- 新增「水墨」画风选项
- 新增图像理解能力,用于分析用户上传的参考图
### 修改
- 角色卡片布局优化,参考图预览尺寸从 80px 改为 120px
### 删除
- 移除「自动分页」功能(用户反馈更希望手动控制分页节奏)
---
## [v1.0] - 2025-12-01
- 初始版本
写作要点
- 版本号:从 v1.0 开始,每次迭代 +0.1,重大改版可以 +1.0
- 日期格式:统一用 YYYY-MM-DD,方便排序和查找
- 变更描述:
- 动词开头(新增、修改、删除、移除、调整)
- 说清楚改了什么、改成什么样
- 新增控件要写位置(如「角色设定区底部」)
- 数值变更要写前后对比(如「从 35% 改为 40%」)
- 如果有原因,简要说明(如「用户反馈不需要」)
- 分类原则:
- 新增:之前没有的功能、控件、能力
- 修改:改变了现有内容的行为、样式、参数
- 删除:移除了之前有的功能
- 颗粒度:一条记录对应一个独立的变更点,不要把多个改动混在一起
- AI 能力变更:如果新增或移除了 AI 能力,必须单独记录