Documentation
README
/shogun-readme-sync - README日英同期
Overview
README.md(英語)とREADME_ja.md(日本語)の差分を検出し、不足セクションの追加・番号ズレの修正を行う。
README変更時のワークフロー:
- 差分検出(どちらが新しいか自動判定)
- 不足セクションのリストアップ
- 翻訳・追記の実行
- セクション番号の整合性チェック
When to Use
- READMEを編集した後(機能追加、セクション追加、構成変更)
- 「README更新」「README同期」「readme sync」と言われた時
- 新機能をREADMEに書いた後に「日本語版も」と言われた時
- PR作成前のREADME整合性チェック
Instructions
Step 1: 差分検出
両ファイルを読み込み、以下の観点で差分を検出する:
# 両ファイルを読む
Read README.md
Read README_ja.md
チェック項目:
| 項目 | 確認方法 |
|---|---|
| セクション数 | ### ヘッダーの数が一致するか |
| セクション番号 | 番号付きセクション(### ... 1., ### ... 2.等)の連番が正しいか |
| ファイル構成 | File Structure / ファイル構成セクション内のファイル一覧が一致するか |
| バージョンセクション | What's New / 新機能 セクションが両方に存在するか |
| 折りたたみ内容 | <details> ブロックの有無が一致するか |
This is the opening of the README. Read the full README on GitHub.