Sync Multilingual README Files

VerifiedSafe

Synchronizes English (README.md) and Chinese (README_ZH.md) documentation by translating new or changed sections between the two files. Preserves code blocks, formatting, and technical term consistency. Useful for maintaining bilingual documentation in multi-language projects.

Sby Skills Guide Bot
DocumentationBeginner
1506/2/2026
Claude Code
#documentation#readme#sync#translation#bilingual

Recommended for

Our review

Synchronizes English README.md and Chinese README_ZH.md files to maintain content parity.

Strengths

  • Ensures consistent bilingual documentation without manual effort.
  • Preserves code blocks, links, and formatting unchanged.
  • Uses a glossary of technical terms for accurate translations.

Limitations

  • Does not handle complex contextual translations beyond the glossary.
  • Requires user input to determine sync direction when ambiguous.
  • Limited to English-Chinese language pair only.
When to use it

Use this skill when maintaining bilingual English-Chinese documentation and need to sync changes between the two versions.

When not to use it

Do not use it for general translation tasks or when you only have documentation in a single language.

Security analysis

Safe
Quality score92/100

The skill only involves reading and writing documentation files (README.md, README_ZH.md) for translation synchronization. No destructive commands, network access, or sensitive data handling is instructed. No external tools are declared, and the operations are benign.

No concerns found

Examples

Sync after English update
Sync README.md and README_ZH.md. The English file was recently updated with a new section on installation instructions.
Sync after Chinese update
Synchronize the README files. I just updated README_ZH.md with additional command examples. Please translate and update the English version accordingly.

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