Description
Maintain multilingual versions of the README to ensure Chinese and English content stay in sync.
Trigger Conditions
- User says "update README", "sync readme", "translate README"
- When README.md has changes
- When new features require documentation updates
File Structure
README.md # 主 README（英文，Primary）
README.zh-TW.md # 繁體中文版本（對照翻譯）
Execution Flow
1. Confirm the source of changes
如果使用者提供中文內容 → 同步到英文版
如果使用者提供英文內容 → 同步到中文版
如果主 README 變更 → 同步兩個版本
2. Main README format
The main README.md uses a bilingual side-by-side format:
- Use language switch links at the top
- Each section first Chinese, then English
- Or use collapsible blocks to separate
3. Translation Principles
- Keep technical terminology consistent (build a glossary)
- Do not translate code examples, only translate comments
- Keep the Markdown structure fully corresponding
- Links point to the corresponding language version
4. Sync Check
## 同步檢查清單
- [ ] 章節數量一致
- [ ] 程式碼區塊一致
- [ ] 連結有效性
- [ ] 術語一致性
Terminology Table
| Chinese | English |
|---|---|
| Constitution | Constitution |
| Sub-law | Bylaws |
| Skill | Skills |
| Memory Bank | Memory Bank |
| Domain-Driven Design | Domain-Driven Design (DDD) |
| Data Access Layer | Data Access Layer (DAL) |
| Commit | Commit |
| Workflow | Workflow |
| Architecture | Architecture |
| Modularization | Modular |
| Cross-conversation | Cross-conversation |
Output Template
Top of the main README.md
# Project Name / 專案名稱
[English](#english) | [繁體中文](#繁體中文)
---
## English
(English content here)
---
## 繁體中文
(中文內容在此)
Or use separate file links
# Project Name
🌐 [English](README.en.md) | [繁體中文](README.zh-TW.md)
(預設語言內容)
Dependent Skills
readme-updater- Basic README update logic
Notes
- Keep the tone consistent when translating (professional but friendly)
- Do not over-interpret; maintain technical accuracy
- Keep Emoji consistent across both versions
- Mark the update date in sync