skills.rest
SmallAi-API
SmallAi-APICOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docs-changelog

Write bilingual EN/ZH product changelog pages in MDX for docs sites.

Updated Jan 27, 2026
Search Tags:#changelog#documentation#technical writing#release notes#i18n#mdx#bilingual
One-click install
npx skills add https://github.com/SmallAi-API/smaihub --skill docs-changelog-smallai-api
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-changelog
Source: https://github.com/SmallAi-API/smaihub/tree/main/.agents/skills/docs-changelog
Command: npx skills add https://github.com/SmallAi-API/smaihub --skill docs-changelog-smallai-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, factual product changelog pages in both English and Chinese is error-prone: files get misnamed, versions drift out of sync, and content becomes marketing fluff. This Skill enforces a strict structure, naming convention, and bilingual synchronization rules for docs changelogs. ## Core Features & Use Cases - Standardized MDX Changelogs: Enforces date-based file naming (YYYY-MM-DD-topic.mdx / .zh-CN.mdx), frontmatter with title, description, and tags, and a recommended content structure. - EN/ZH Synchronization: Keeps key facts, section order, and scope aligned across language pairs without literal translation. - Scope Guardrails: Explicitly excludes GitHub Release notes and delegates release PR bodies to a separate skill, while requiring companion microcopy and i18n skills. - Use Case: After shipping a feature, collect facts from PRs and commits, then generate paired English and Chinese changelog pages under docs/changelog/ with aligned structure and concise improvement bullets. ## Quick Start Write the English and Chinese docs changelog pages for the new dashboard export feature shipped on 2025-01-15.

Frequently Asked Questions about docs-changelog

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

FAQPage Schema
How do I write a bilingual product changelog for a docs site?▼

Create paired MDX files using date-based names like YYYY-MM-DD-topic.mdx and YYYY-MM-DD-topic.zh-CN.mdx. Keep the same key facts and section order in both languages, localize naturally rather than translating literally, and lead with user-facing impact.

What frontmatter should an MDX changelog page include?▼

Each changelog MDX file should include title, a one-sentence user-facing description, and feature-oriented tags. The title should match the H1 heading in meaning, and tags should describe features rather than internal team labels.

Does this skill handle GitHub Release notes?▼

No. This skill only covers changelog pages under docs/changelog/*.mdx. For GitHub Release notes or release PR bodies, it explicitly delegates to the separate version-release skill.

How long should a product changelog entry be?▼

Length scales with the release: small updates need 3-5 short paragraphs, medium updates 4-7 paragraphs plus concise fix bullets, and large updates 6-10 paragraphs split into 2-4 sections. Avoid padding when changes are limited.

How do I keep English and Chinese changelogs in sync?▼

Keep the same key facts in the same order across both files, align section structure, and ensure improvement bullet lists have equivalent intent. Never introduce a capability in only one language unless explicitly requested.

Related Skills

Explore More Content & Communication Skills→
dereknexdereknex

app-store-changelog

Collect git history changes and draft App Store release notes.

Community
Intermediate
elie222elie222
12.1k

changelog

Creates user-facing changelog entries and regenerates the aggregated changelog file.

Community
Intermediate
duwenjiduwenji

microcopy

Standardizes multilingual UI microcopy for Hub-like platforms with fixed terminology and tone rules.

Community
Basic
sanity-iosanity-io
6.3k

pr-description

Generate GitHub PR descriptions and release notes from commit history.

Official
Intermediate