skills.rest
tqer39
tqer39COMMUNITY
Explore all skills by this author →
𝕏@tqer39GitHub

readme-sync

Propagate edits between English and Japanese README files while preserving structure.

3|Updated Apr 22, 2026
Search Tags:#workflow#documentation#readme#sync#bilingual#version-control
One-click install
npx skills add https://github.com/tqer39/ccw-cli --skill readme-sync-tqer39
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: readme-sync
Source: https://github.com/tqer39/ccw-cli/tree/main/.claude/skills/readme-sync
Command: npx skills add https://github.com/tqer39/ccw-cli --skill readme-sync-tqer39

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps two READMEs in sync to prevent drift between English and Japanese project documentation.

Core Features & Use Cases

  • Propagates edits between README.md and docs/README.ja.md to maintain parallel structure and content.
  • Activates on changes to either file or user requests about "the README", ensuring consistency across languages.
  • Mirrors structural and content changes while preserving language-specific wording and links (e.g., language switcher).

Quick Start

Edit README.md or docs/README.ja.md, and the skill will propagate the changes to the other file.

Frequently Asked Questions about readme-sync

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep English and Japanese README files in sync automatically?▼

To keep English and Japanese README files in sync, this skill propagates semantic updates between README.md and docs/README.ja.md to prevent documentation drift. It mirrors content changes while preserving language-specific wording and structure.

What is the best way to prevent bilingual documentation drift in version control?▼

Preventing bilingual documentation drift requires a structured workflow to identify the source of truth and mirror content changes. This approach ensures parallel structure and content across both language files during version control updates.

How do I mirror README edits to another language without breaking links?▼

Mirroring README edits safely requires preserving language-specific wording and structural elements. The process ensures language switcher links remain correct and functional while applying semantic updates between the English and Japanese files.

Does the documentation sync work if I edit either the English or Japanese file?▼

Yes, the documentation sync activates on changes to either file. Whether you edit README.md or docs/README.ja.md, the skill identifies the source of truth and propagates the updates to the other file.

When do I need to use a structured workflow for bilingual README files?▼

A structured workflow for bilingual README files is needed when you want to maintain parallel structure and content across languages. It becomes essential when updates occur frequently and manual synchronization would cause documentation drift.

Related Skills

Explore More Content & Communication Skills→
CruxExpertsCruxExperts
3

ls-automatic-versioning

Derive MAJOR.MINOR.PATCH versions from conventional commits and synchronize docs.

Community
Intermediate
a-taka-tak
1

git-commit-push

Automates staging, committing, and pushing with standardized Git workflow.

Community
Basic
mikopbxmikopbx
569

restapi-translations

Synchronize missing and unused REST API translation keys in PHP projects.

Official
Intermediate
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate