| name | project-changelog |
| description | 按本仓库规范撰写、整理、重命名中文更新日志(更新日志_日期_版本.txt)。 聚合模块级变更、禁止罗列具体 Markdown 文件名。 在用户提到更新日志、发行说明、版本发布说明、changelog、更新日志_模板 时使用。 |
项目更新日志(中文)
文件约定
| 项 | 规则 |
|---|
| 模板 | references/更新日志_模板.txt(代码/多语言对齐;撰写前先读) |
| 成品命名 | 更新日志_<YYYY-MM-DD>_v<主.次.补丁>.txt,例如 更新日志_2026-05-20_v1.0.1.txt |
| 禁止 | 长期使用无日期版本的 更新日志.txt;每次发布单独一个文件 |
| 版本/日期 | 页眉中的「版本」「更新日期」必须与文件名一致 |
每次新版本:新建带日期+版本号的文件,勿覆盖历史文件。
撰写流程
- 从
git diff、对话或任务清单收集变更点。
- 按模块聚合(见下),不要按单个
.md 文件逐条罗列。
- 套用下方结构写入新文件。
- 核对页眉、文件名、文末汇总表三者版本与日期一致。
文档类变更:聚合规则
要写:模块/栏目名(中文文档首页、VitePress 站点配置、架构设计、小白教程、面试准备、代码讲解等)。
不要写:docs/zh/xxx.md、index.md 等具体 Markdown 路径或文件名。
例外:代码变更、配置类可写语言 + 路径(如 Java — MonitorAgent.java),与 references/更新日志_模板.txt 一致。
同一模块多条改动合并为 1~3 条 bullet,用「;」或子 bullet 归纳。
正文结构(固定)
============================================================
<项目中文名> — <本次更新主题>更新摘要
版本:vX.Y.Z
更新日期:YYYY-MM-DD
============================================================
背景
----
<1~3 句:为何更新、对齐目标、范围>
============================================================
<大章节标题> ← 按 P0/P1/P2 或 功能域 分组
============================================================
N. <条目标题>
-----------------------------------------------
<可选:语言/子模块>
- 变更点
- 变更点
============================================================
变更范围汇总
============================================================
模块 说明
------------------------ ------------------------------------------
... 一行概括
章节划分建议
| 发布类型 | 章节示例 |
|---|
| 文档/站点 | 文档首页与站点配置;架构、教程与面试;三语言代码讲解 |
| 代码对齐 | P0 核心能力;P1 生产级;P2 丰富度(照模板) |
| 混合 | 先代码后文档,或分「代码」「文档」两大块 |
条目编号 1. 2. … 连续;子标题下用 ----------------------------------------------- 分隔。
变更范围汇总表
文末必须有表格:左列「模块」,右列「说明」一行概括;不出现 .md 文件名。可写篇数,如「小白教程(2 篇)」。
代码类发布可另加「文件变更清单」小节([新增]/[修改] + 路径),文档类发布用汇总表即可。
语言与风格
- 全文简体中文。
- 动词开头:新增、修复、改为、扩充、清理。
- 能量化则量化(13 处链接、30 题→55 题、69 行→260 行)。
- 技术栈、Agent 名、算法名保持与仓库一致,不臆造。
示例(文档发布 · 聚合写法)
4. 面试准备
-----------------------------------------------
- 问答集:30 题扩充至 55 题,覆盖项目设计 / 技术实现 / 架构 / 广告业务 4 大类
- 八股文:RTB 流程图改为 Mermaid,新增三语言错误处理与测试策略对比
反例(不要):
docs/zh/interview/qa-collection.md
- 面试题扩充
检查清单
目录结构
project-changelog/
├── SKILL.md # 规范(本文件)
└── references/
└── 更新日志_模板.txt # 代码/多语言对齐类样板
成品输出在仓库根目录:更新日志_<日期>_v<版本>.txt(勿放入 Skill 目录)。
参考文件
撰写代码类:先读 references/更新日志_模板.txt,改页眉与条目后写到仓库根新文件。
撰写文档类:按本 SKILL 正文写;需要对照时打开仓库根历史成品。