Skip to main content
Agent skill

Docs Changelog

Use for EN/ZH website product changelogs in docs/changelog/.mdx. Excludes GitHub Release notes.

All install options
Quick install · Personal (~/.claude/skills)Project / Cursor / Desktop →
mkdir -p ~/.claude/skills/docs-changelog && curl -fsSL 'https://raw.githubusercontent.com/lobehub/lobehub/canary/.agents/skills/docs-changelog/SKILL.md' -o ~/.claude/skills/docs-changelog/SKILL.md

Get the complete skill folder, including its scripts and reference files.

When to use this skill

Use Docs Changelog when an AI agent needs a reusable SKILL.md workflow for this job: Use for EN/ZH website product changelogs in docs/changelog/.mdx. Excludes GitHub Release notes.

When not to use it

Skip Docs Changelog when the task is outside the writing category, or when a more specific skill in this directory already covers the same workflow with clearer triggers.

How to install

Where will you use it?

Install scope
One-line install (Claude Code)
mkdir -p ~/.claude/skills/docs-changelog && curl -fsSL 'https://raw.githubusercontent.com/lobehub/lobehub/canary/.agents/skills/docs-changelog/SKILL.md' -o ~/.claude/skills/docs-changelog/SKILL.md
  1. Claude Code personal install: place the skill and its bundled files at ~/.claude/skills/docs-changelog/SKILL.md. For a shared project, commit the folder at .claude/skills/docs-changelog/ instead.
  2. Current Claude Code detects SKILL.md changes in watched directories during the session. If you just created a top-level skills directory, run /reload-skills. Check that the skill is listed before testing its trigger.
  3. For Claude chat or Cowork in the Desktop app, manage uploaded skills in Customize > Skills; copying files into a local Claude Code folder is not a Desktop install. Other agents may use different install locations.

Full install guide for Claude, Cursor, and Codex →

Try a starter prompt

After installing the skill, paste this starter prompt into your agent to verify it triggers on a small task.

Starter prompt
Use the Docs Changelog skill for this task: Use Docs Changelog when this documented workflow matches the task. Confirm any required inputs or files before making changes.

What supports this recommendation?

68/100 provisional content score. This measures documentation, practical detail and source signals. It is not a measured task success rate or a security certification.

Documentation
69/100
Practical detail
68/100
Source evidence
63/100
Source signals
72/100
Model compatibility evidence
  • claudeuntested

    No model-specific signal or recorded compatibility test was found.

  • chatgptuntested

    No model-specific signal or recorded compatibility test was found.

  • geminiuntested

    No model-specific signal or recorded compatibility test was found.

  • copilotuntested

    No model-specific signal or recorded compatibility test was found.

  • llamauntested

    No model-specific signal or recorded compatibility test was found.

  • perplexityuntested

    No model-specific signal or recorded compatibility test was found.

  • mistraluntested

    No model-specific signal or recorded compatibility test was found.

  • grokuntested

    No model-specific signal or recorded compatibility test was found.

Inferred compatibility is based on content signals. Check the app, its available tools and setup requirements before running a skill.

What this skill does

# Docs Changelog Writing Guide

## Scope Boundary (Important)

This skill is only for changelog pages in:

- `docs/changelog/*.mdx`

This skill is **not** for GitHub Releases.\ If the user asks for release PR body / GitHub Release notes, load `../version-release/SKILL.md`.

## Mandatory Companion Skills

For every docs changelog task, you MUST load:

- `../../../DESIGN.md` (Voice & Content) - `../i18n/SKILL.md` (when EN/ZH pair is involved)

## File and Naming Convention

Use date-based file names:

- English: `docs/changelog/YYYY-MM-DD-topic.mdx` - Chinese: `docs/changelog/YYYY-MM-DD-topic.zh-CN.mdx`

EN and ZH files must exist as a pair and describe the same release facts.

## Frontmatter Requirements

Each file should include:

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

Rules:

1. `title` should match the H1 title in meaning. 2. `description` should be concise and user-facing. 3. `tags` should be feature-oriented, not internal-team labels.

## Content Structure (Recommended)

Use this shape unless the user requests otherwise:

1. `# <Title>` 2. Opening paragraph (2-4 sentences): user-visible impact 3. 1-3 capability sections (optional `##` headings) 4. `## Improvements and fixes` / `## 体验优化与修复` with concise bullets

Keep heading count low and avoid heading-per-bullet structure.

## Writing Rules

1. Keep all claims factual and tied to actual shipped changes. 2. Explain user value first, implementation second. 3. Prefer natural narrative paragraphs over pure bullet dumps. 4. Avoid marketing exaggeration and vague adjectives. 5. Keep internal terms consistent across EN/ZH files. 6. Keep EN/ZH section order aligned and scope-aligned.

## EN/ZH Synchronization Rules

When generating bilingual changelogs:

1. Keep the same key facts in the same order. 2. Localize naturally; do not do literal sentence-by-sentence translation. 3. If one version has an `Improvements and fixes` bullet list, the other should have equivalent list intent. 4. Do not introduce capabilities in only one language unless explicitly requested.

## Length Guidance

- Small update: 3-5 short paragraphs total - Medium update: 4-7 short paragraphs + concise fix bullets - Large update: 6-10 short paragraphs split into 2-4 sections

Do not pad content when changes are limited.

## Authoring Workflow

1. Collect source facts from PRs/commits/issues. 2. Group changes by user workflow (not by internal module path). 3. Draft EN and ZH versions with aligned structure. 4. Verify terminology using DESIGN.md (Voice & Content) / `i18n` guidance. 5. Final pass: remove AI-like filler and tighten sentences.

## Docs Changelog Template (English)

```md --- 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> ```

## Docs Changelog Template (Chinese)

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

# <功能标题>

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

<可选能力段 1。>

<可选能力段 2。>

## 体验优化与修复

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

## Quick Checklist

- [ ] File path matches `docs/changelog` naming convention - [ ] EN and ZH versions both exist and match in facts - [ ] Opening paragraph explains user-facing outcome - [ ] Main body is narrative-first, not bullet-only - [ ] `Improvements and fixes` section is concise and concrete - [ ] No fabricated claims or unsupported scope

Intended uses

  • Use Docs Changelog when this documented workflow matches the task.

Implementation notes

  • Review the source instructions and adapt inputs before running the workflow.

Try it, then tell us how it went

A copied prompt does not tell us whether the task worked. Report your result after checking the output. We collect your tool and outcome, never your files or prompt.