バイリンガルドキュメント管理
ドキュメント構造
text
tts-partner/ ├── README.md # 英語(デフォルト) ├── CLAUDE.md # 英語(デフォルト) ├── docs/ │ ├── README.ja.md # 日本語版 README │ ├── CLAUDE.ja.md # 日本語版 CLAUDE.md │ ├── setup.md # 英語 │ ├── setup.ja.md # 日本語 │ └── ...
言語リンクの形式
各ドキュメントの先頭に相互リンクを設置:
英語版(ルート):
markdown
# Title [🇯🇵 日本語](docs/FILENAME.ja.md)
日本語版(docs/):
markdown
# タイトル [🇺🇸 English](../FILENAME.md)
作成ルール
- •デフォルト言語: 英語(ルートに配置)
- •日本語版:
docs/配下に.ja.md拡張子で作成 - •相互リンク: 国旗 + 言語名で先頭に配置
- •内容の同期: 両言語で同じ構造・情報を維持
手順
新規ドキュメント作成時
- •英語版をルートまたは
docs/に作成 - •対応する日本語版を
docs/*.ja.mdに作成 - •両ファイルに相互リンクを追加
既存ドキュメント更新時
- •片方を更新したら、もう一方も更新
- •構造の変更は両方に反映
対象ファイル
| 英語 | 日本語 |
|---|---|
README.md | docs/README.ja.md |
CLAUDE.md | docs/CLAUDE.ja.md |
docs/setup.md | docs/setup.ja.md |
docs/api.md | docs/api.ja.md |