README 4-file synchronization procedure for the oss-docs harness: Korean README.ko.md as primary source, en/ja/zh derivation, the shared language-switcher header contract, section-order parity checklist, and the manual verification recipe (no linter exists for READMEs). Loaded by the content-author and locale-translator specialists for any README work.
82%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
Passed
No findings from the security scan
The GitHub-facing README set is 4 files at the repo root:
| File | Locale | Role |
|---|---|---|
README.ko.md | ko | canonical / primary — author here first |
README.md | en | derived |
README.ja.md | ja | derived |
README.zh.md | zh | derived |
Chain history: the canonical locale was English until 2026-08-17, when card t47 promoted the ko new-skeleton (feature-oriented section structure) to canonical per the operator decision — aligning the README chain with the docs-site chain, which was already ko-canonical. The former en-skeleton redesign reference (
.moai/reports/readme-docs-redesign-20260713.md) is superseded by the ko skeleton and kept as history only.
README.ko.md (Korean) only. Respect the
canonical ko section skeleton; keep the file length in the range of the
current set.All 4 files share the same switcher header near the top, linking the sibling files with the label set exactly:
English · 한국어 · 日本語 · 中文grep -c '^## ' README.md README.ko.md README.ja.md README.zh.md —
identical H2 counts across the 4 files.grep '^## ' output order).```` grep -c '^```' ```` is even and equal).grep -n 'docs\.moai-ai\.dev\|adk\.moai\.com\|adk\.moai\.kr' README*.md → no matches.No linter exists for the README set — verification is the manual recipe above
plus rendering sanity: preview the markdown (GitHub-flavored) for the touched
sections and confirm Mermaid blocks declare TD/TB only. The runnable
docs-site checks live in Skill("hns-oss-docs-verify"); the README-specific
checks are the greps above.
| Anti-pattern | Correct approach |
|---|---|
Editing README.md first "because GitHub is English-facing" | README canonical is ko — author README.ko.md, then derive |
| Re-authoring an entire derived file for a 3-line canonical change | Minimal-diff derivation of the changed sections |
| "Improving" facts/figures during translation | Report the discrepancy; amend canonical first |
| Dropping the switcher header in a redesign | The 4-entry header is a HARD shared contract |
modu-ai/moai-adk
c4784db
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.