| name | release-notes-user-facing |
| description | Writing user-facing release notes for MapleTools (or similar desktop apps). Use when drafting or revising changelog/release note documents intended for end users, not developers. |
用户向发布公告写作准则
核心原则
受众是普通用户,不是开发者。 用户只关心"这个更新对我有什么用",不关心实现细节。
具体规则
长度
- 每条一句话,能短则短。用户不会读长段落。
- 不要列子功能点,不要解释原理。
新增功能
- 全新页面 / 模块:一句话说清楚"新增了什么,能干什么",不要展开列功能点。
- ✅
新增文件浏览器,可在应用内直接浏览和管理本地文件,支持列表 / 网格视图、排序等功能
- ❌ 列 5 条子 bullet 描述各个特性(那是文档,不是公告)
- 对现有功能的扩展:直接说新增了什么,不需要说"优化了 XX 功能"。
优化
- 只写用户能感知到的结果,不写技术手段。
- ✅
下载更稳定,暂停操作行为更符合预期
- ❌
调度模型优化:同源任务改为单槽串行调度,不同源可并行
- 用户无感知的性能优化(防抖、节流、原子写入等)不需要写。
修复
- 直接说修复了什么现象,不说代码层面的原因。
- ✅
修复 Xifan 取消下载后闪退
- ❌
修复 abort 后写入已销毁流导致的闪退
- 对于细节不重要的修复,可以用"修复已知的问题"带过。
- 技术背景对用户无意义的可以略去(如"原子写入防数据损坏"→ 不写,或改为"修复异常退出时下载记录丢失")。
什么不写
- 用户无感知的变化:请求延迟、防抖间隔、日志、构建脚本、代码重构
- 移除的内部功能(如单集暂停改为任务级暂停,用户不需要知道"移除了")
- 分页加载、缓存 TTL 对齐等后端细节
结构参考
### 新增
**分类名**
- 一句话描述
### 优化
- 用户能感知的改进
### 修复
**分类名**
- 修复了什么现象