Sync README Multilingual

VerifiedSafe

Synchronize English README.md with Chinese README_ZH.md maintaining content parity. Translates and updates modified sections based on identified direction.

Sby Skills Guide Bot
DocumentationIntermediate
506/2/2026
Claude Code
#readme#sync#translation#documentation#localization

Recommended for

Our review

This skill synchronizes English and Chinese README files by translating updated sections while preserving document structure.

Strengths

  • Maintains content parity between two languages
  • Preserves code blocks, links, and tables
  • Uses consistent technical terminology

Limitations

  • Requires a clear source of truth (English or Chinese)
  • May not handle cultural or idiomatic nuances
  • Relies on machine translation quality
When to use it

Use this skill when you have bilingual READMEs (EN/ZH) and want to keep them in sync automatically.

When not to use it

Do not use for non-technical translations or if you prefer full human review after translation.

Security analysis

Safe
Quality score90/100

The skill only performs read/write operations on documentation files (README.md and README_ZH.md). No external commands, network requests, or handling of secrets is involved. The risk is negligible.

No concerns found

Examples

Sync from English to Chinese
Sync README.md with README_ZH.md. The English version was updated recently, so translate new sections from English to Chinese.
Sync from Chinese to English
Sync README_ZH.md with README.md. The Chinese version is the source of truth now, translate changes to English.
Full resync both files
Compare README.md and README_ZH.md and synchronize them. Use the English version as the primary source, but make sure all sections from Chinese are also included.

name: sync-readme description: Synchronize English README.md with Chinese README_ZH.md, maintaining content parity.

Sync README

Purpose

Keep the English (README.md) and Chinese (README_ZH.md) documentation in sync. When one is updated, this skill helps translate and synchronize changes to the other.

Instructions

  1. Compare Both Files

    • Read README.md and README_ZH.md
    • Identify sections that differ
    • Note new sections in either file
  2. Determine Sync Direction

    • If English was updated more recently: translate EN → ZH
    • If Chinese was updated more recently: translate ZH → EN
    • If unclear, ask user which is the source of truth
  3. Translate Content

    • Preserve all code blocks unchanged
    • Translate prose sections accurately
    • Keep technical terms consistent:
      • "rules" → "规则"
      • "commands" → "命令"
      • "skills" → "技能"
      • "agents" → "代理"
      • "instructions" → "指令"
      • "adapter" → "适配器"
      • "symbolic link" → "软链接"
  4. Preserve Structure

    • Keep same heading hierarchy
    • Maintain table formats
    • Preserve all links and badges
    • Keep code examples identical
  5. Update Language Links

    • Ensure language toggle links are present
    • English: [English](./README.md) | [中文](./README_ZH.md)
    • Chinese: [English](./README.md) | [中文](./README_ZH.md)
  6. Verify Completeness

    • All sections present in both files
    • All features documented in both
    • Examples work in both versions

Translation Guidelines

Section Headers

| English | Chinese | |---------|---------| | Install | 安装 | | Commands | 命令 | | Architecture | 架构 | | Tab Completion | Tab 补全 | | Legacy compatibility | Legacy 兼容说明 | | Supported Sync Types | 支持的同步类型 |

Common Phrases

| English | Chinese | |---------|---------| | Default mapping | 默认映射 | | Source directory | 源目录 | | Target directory | 目标目录 | | Run this command | 运行此命令 | | This command will | 该命令会 |

Output

After running this skill:

  • Both README files contain identical information
  • All features documented in both languages
  • Formatting consistent across both files
Related skills