- 分組
- 回顾 · 版本或阶段变化
- 元件
RetroLog·#retro-log
適合
- 版本更新、阶段回顾
- 每一条一句话能说清
不適合
- 要按真实时间比例:用 Timeline
- 每条要多段说明:用 Milestones
內容上限
| 1 | entries 4–6 条,最新在前:ver ≤ 10 字符,tag ≤ 6 字,text ≤ 30 字 |
| 2 | note.title ≤ 10 字符,lines 2–3 行各 ≤ 16 字 |
| 3 | title ≤ 1 行 × 16 字 |
欄位
| 欄位 | 型別 | |
|---|---|---|
kicker · 必填 | string | 小节名,2–8 字 |
title · 必填 | string | string[] | 标题;数组手动断行 |
lead | string | 一两句导语,≤ 60 字 |
source | string | 事实出处 |
file · 必填 | string | 窗口标题 |
entries · 必填 | { ver, tag, text }[] | 日志条目 |
note · 必填 | { title, lines } | 便签窗口 |
範例程式碼
<RetroLog kicker="更新日志" title="四期下来,模板从 67 到 103" file="CHANGELOG.txt" entries={[{ ver: '第 4 期', tag: '风格', text: '…' }, …]} note={{ title: 'NOTE.txt', lines: ['风格只换外观', '…'] }} />