skills.rest
OpenSourceAGI
OpenSourceAGIOFFICIAL
Explore all skills by this author →
GitHub

docs-changelog

Write bilingual EN/ZH changelog pages as MDX files for product documentation sites.

74|11|Updated Jul 4, 2024
Search Tags:#changelog#documentation#technical writing#release notes#i18n#mdx#bilingual
One-click install
npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill docs-changelog-opensourceagi
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-changelog
Source: https://github.com/OpenSourceAGI/qwksearch-research-agent/tree/main/apps/qwk-in-lobe/.agents/skills/docs-changelog
Command: npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill docs-changelog-opensourceagi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing consistent, user-facing changelog pages for a docs site is repetitive and error-prone, especially when every update must be published in both English and Chinese with aligned facts, structure, and terminology. ## Core Features & Use Cases - Standardized MDX Changelogs: Enforces date-based file naming, frontmatter (title, description, tags), and a narrative-first content structure for docs/changelog pages. - EN/ZH Synchronization: Guarantees paired English and Chinese files with aligned facts, section order, and natural localization rather than literal translation. - Scope Guardrails: Clearly separates docs changelog writing from GitHub Release notes, and requires companion voice/i18n guidance for consistent tone. - Use Case: After shipping a feature, collect the PR facts and ask for a changelog post; you get docs/changelog/2025-01-15-feature.mdx and its .zh-CN.mdx counterpart, both following the template with an improvements-and-fixes section. ## Quick Start Write an English and Chinese docs changelog page for the latest feature update using the facts from these merged PRs.

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 changelog page for a docs site?▼

Create a date-named MDX file under docs/changelog with frontmatter (title, description, tags), an opening paragraph on user impact, optional capability sections, and a concise improvements-and-fixes list. Keep claims factual and tied to shipped changes.

How to keep English and Chinese changelog versions in sync?▼

Create paired files like topic.mdx and topic.zh-CN.mdx with the same key facts in the same order. Localize naturally instead of translating sentence by sentence, and keep section structure and improvements lists equivalent.

What is the difference between docs changelogs and GitHub Release notes?▼

Docs changelogs are user-facing MDX pages in docs/changelog written in narrative style for product updates. GitHub Release notes follow a different format and workflow, handled by a separate version-release skill, not this one.

What frontmatter does an MDX changelog file need?▼

Each changelog MDX file needs a title matching the H1 in meaning, a one-sentence user-facing description, and feature-oriented tags. Avoid internal team labels in tags and keep the description concise.

How long should a product changelog post be?▼

Length depends on scope: small updates need 3-5 short paragraphs, medium updates 4-7 paragraphs plus fix bullets, and large updates 6-10 paragraphs across 2-4 sections. Do not pad content when changes are limited.

Related Skills

Explore More Content & Communication Skills→
EveryIncEveryInc
24.7k

ce-promote

Draft launch and promotion copy for shipped features across social channels.

Official
Advanced
mindfold-aimindfold-ai
14.4k

create-manifest

Create Trellis release migration manifests and bilingual docs-site changelogs from git commits.

Official
Advanced
propane-aipropane-ai
4

brand-voice

Review content for brand voice, style guide, and messaging compliance.

Official
Intermediate
AI-Foundry-CoreAI-Foundry-Core
4

changelog-automation

Generate changelogs from commits, PRs, and releases using Keep a Changelog format.

Official
Advanced