docs-changelog

Write bilingual EN/ZH changelog pages for docs/changelog/*.mdx with required frontmatter.

1|Updated May 9, 2026
One-click install
npx skills add https://github.com/duwenji/generative-ai-oss-tutorials --skill docs-changelog-duwenji
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-changelog
Source: https://github.com/duwenji/generative-ai-oss-tutorials/tree/main/sandbox/lobe-chat/.agents/skills/docs-changelog
Command: npx skills add https://github.com/duwenji/generative-ai-oss-tutorials --skill docs-changelog-duwenji

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you draft consistent, user-facing documentation changelog pages for your site without mixing scope, formatting, or EN/ZH facts, so updates are easy to trust and easy to scan.

Core Features & Use Cases

  • Changelog scope control: Ensures you only write for docs/changelog/*.mdx, not GitHub Release notes, and routes release-note requests to the correct companion skill.
  • Strict bilingual consistency: Keeps EN and ZH files as an aligned pair with the same key facts in the same order, while localizing naturally.
  • Opinionated structure & quality rules: Produces pages with the required frontmatter and a clear narrative-first body, including a concise “Improvements and fixes / 体验优化与修复” section grounded in real shipped changes.

Quick Start

Create or edit docs/changelog/YYYY-MM-DD-topic.mdx (and the matching .zh-CN.mdx) using the required frontmatter fields and an H1 title that matches the page’s meaning.

Frequently Asked Questions about docs-changelog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write bilingual docs changelog updates in MDX?

Bilingual docs changelog pages require aligned EN and ZH `.mdx` files under `docs/changelog/` with matching frontmatter fields like title, description, and tags. Both language versions must share the same key facts in the same order while localizing naturally for end users.

What frontmatter is required for a product update changelog page?

Required frontmatter for a product update changelog page includes at least title, description, and tags fields. The MDX file must also feature an H1 title matching the page's meaning and a concise improvements section grounded in real shipped release facts.

Does docs changelog writing cover GitHub Release notes too?

Docs changelog writing does not cover GitHub Release notes. It strictly ensures you only write for `docs/changelog/*.mdx` files and routes any release-note requests to the correct companion skill to prevent scope and formatting inconsistencies.

What is the correct filename convention for MDX changelog posts?

The correct filename convention for MDX changelog posts is `docs/changelog/YYYY-MM-DD-topic.mdx` for English, paired with a matching `.zh-CN.mdx` file. This maintains strict bilingual structure and aligned facts for end users.

How do I keep EN and ZH changelog facts consistent across translations?

To keep EN and ZH changelog facts consistent, treat the files as an aligned pair with the same key facts in the same order. Localize naturally while ensuring the narrative-first body and improvements section reflect identical shipped release facts.