mcpField
D
docs-changelog

docs-changelog

github.com/lobehub文档处理83.6k103 次安装今天更新
代码仓库

关于 docs-changelog

docs-changelog 是用于编写 `docs/changelog/*.mdx` 中英文更新日志页面的技能，提供文件命名、结构和内容规范，并要求中英文版本事实一致。不适用于 GitHub Releases。

主要功能

  1. 01按日期命名更新日志文件
  2. 02提供 frontmatter 和页面结构规范
  3. 03对齐中英文事实与章节
  4. 04强调事实准确和用户价值
  5. 05规定必需的配套技能

适用场景

  1. 01起草文档更新日志页面
  2. 02准备中英文对应的更新日志
  3. 03检查更新日志结构和元数据

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/lobehub/lobehub --skill docs-changelog

安装后在 Claude Code 中输入/docs-changelog确认已加载。

详细介绍

文档更新日志撰写指南

适用范围（重要）

本技能仅适用于以下位置的更新日志页面：

  • docs/changelog/*.mdx

本技能不适用于 GitHub Releases。
如果用户要求撰写发布 PR 正文或 GitHub Release 说明，请加载 ../version-release/SKILL.md。

必须配合使用的技能

对于每项文档更新日志任务，必须加载：

  • ../../../DESIGN.md（语气与内容）
  • ../i18n/SKILL.md（涉及 EN/ZH 双语版本时）

文件命名约定

使用基于日期的文件名：

  • 英文：docs/changelog/YYYY-MM-DD-topic.mdx
  • 中文：docs/changelog/YYYY-MM-DD-topic.zh-CN.mdx

EN 和 ZH 文件必须成对存在，并描述相同的发布事实。

Frontmatter 要求

每个文件都应包含：

---
title: <Title>
description: <1 sentence summary>
tags:
  - <Tag 1>
  - <Tag 2>
---

规则：

  1. title 的含义应与 H1 标题一致。
  2. description 应简洁，并面向用户。
  3. tags 应围绕功能，而非内部团队标签。

内容结构（建议）

除非用户另有要求，否则采用以下结构：

  1. # <Title>
  2. 开篇段落（2-4 句话）：说明用户可见的影响
  3. 1-3 个功能章节（可选的 ## 标题）
  4. ## Improvements and fixes / ## 体验优化与修复，包含简洁的项目符号列表

保持标题数量精简，避免每个项目符号都单独设为一个标题。

写作规则

  1. 所有说法都应属实，并与实际发布的变更相符。
  2. 优先说明用户价值，再说明实现方式。
  3. 优先使用自然叙述段落，而不是纯项目符号列表。
  4. 避免夸大宣传和含糊的形容词。
  5. 确保 EN/ZH 文件中的内部术语保持一致。
  6. 确保 EN/ZH 版本的章节顺序和内容范围一致。

EN/ZH 同步规则

编写双语更新日志时：

  1. 按相同顺序保留相同的关键信息。
  2. 自然地进行本地化；不要逐句直译。
  3. 如果一个版本包含 Improvements and fixes 项目符号列表，另一个版本也应包含意图相同的列表。
  4. 除非明确要求，否则不要只在一种语言中引入某项功能。

长度建议

  • 小型更新：总计 3-5 个简短段落
  • 中型更新：4-7 个简短段落，并附简洁的修复项目符号
  • 大型更新：6-10 个简短段落，分为 2-4 个章节

变更有限时，不要为了凑长度而添加内容。

编写工作流程

  1. 从 PR、提交记录和问题中收集源信息。
  2. 按用户工作流对变更分组，而不是按内部模块路径分组。
  3. 撰写结构一致的 EN 和 ZH 版本。
  4. 参照 DESIGN.md（语气与内容）/ i18n 指南核对术语。
  5. 最后检查：删除 AI 式填充内容，并精简措辞。

文档更新日志模板（英文）

---
title: <Feature title>
description: <One-sentence summary for users>
tags:
  - <Tag A>
  - <Tag B>
---

# <Feature title>

<Opening paragraph: what changed for users and why it matters.>

<Optional section paragraph for key capability 1.>

<Optional section paragraph for key capability 2.>

## Improvements and fixes

- <Fix or optimization 1>
- <Fix or optimization 2>

文档更新日志模板（中文）

---
title: <功能标题>
description: <一句话说明>
tags:
  - <标签 A>
  - <标签 B>
---

# <功能标题>

<开场段：这次更新给用户带来的直接变化。>

<可选能力段 1。>

<可选能力段 2。>

## 体验优化与修复

- <优化或修复 1>
- <优化或修复 2>

快速检查清单

  • 文件路径符合 docs/changelog 命名约定
  • EN 和 ZH 版本均存在，且所述事实一致
  • 开篇段落说明了对用户的影响
  • 正文以叙述为主，而非仅使用项目符号
  • Improvements and fixes 章节简洁具体
  • 未编造说法或加入缺乏依据的内容

评论

支持 Markdown