README 4-file synchronization procedure for the oss-docs harness: English README.md as primary source, ko/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.
68
83%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
The GitHub-facing README set is 4 files at the repo root, ~1100 lines each:
| File | Locale | Role |
|---|---|---|
README.md | en | canonical / primary — author here first |
README.ko.md | ko | derived |
README.ja.md | ja | derived |
README.zh.md | zh | derived |
SSOT design reference for redesign work:
.moai/reports/readme-docs-redesign-20260713.md (README full redesign draft
README.md (English) only. Respect the section
design from the SSOT report; keep the ~1100-line budget in mind.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.ko.md first "because the user speaks Korean" | README canonical is en — author README.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 |
05117b6
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.