--- name: doc-generate description: | ドキュメント生成・更新時に使用。英語版(.md)と日本語版(.ja.md)の 相互リンク設定と命名規則を自動適用する。 --- # Document Generation Skill 新規ドキュメントを作成し、英日両言語版と相互リンクを設定する。 ## ファイル命名規則 - 英語版: `docs/{name}.md` - 日本語版: `docs/{name}.ja.md` ## 相互リンク形式 ### 英語版の先頭(タイトル直後) ```markdown # {Title in English} [🇯🇵 日本語版](./{name}.ja.md) ``` ### 日本語版の先頭(タイトル直後) ```markdown # {日本語タイトル} [🇺🇸 English](./{name}.md) ``` ## 作成手順 1. 英語版 `docs/{name}.md` を作成 2. 日本語版 `docs/{name}.ja.md` を作成 3. 両ファイルに相互リンクを追加 4. `just lint` で検証 ## 既存ドキュメントの更新 片方のみ存在する場合、対となるファイルを作成: - `.ja.md` のみ → `.md` を作成(英訳) - `.md` のみ → `.ja.md` を作成(和訳) ## 言語別の記述ルール ### 英語版 (.md) - 技術用語は一般的な英語表現を使用 - 簡潔で明確な文章 - コード例のコメントも英語 ### 日本語版 (.ja.md) - 技術用語はカタカナまたは原語を適宜使用 - 敬体(です・ます調)で統一 - コード例のコメントは日本語 ## 対象外 以下は多言語の対応が不要: - `docs/plans/` 配下の計画書 - `.claude/` 配下の設定ファイル - `infra/` 配下の README