← Back to list

doc-generate
by tqer39
XTrade - Trading platform and analysis tools
⭐ 0🍴 0📅 Jan 25, 2026
SKILL.md
name: doc-generate description: | ドキュメント生成・更新時に使用。英語版(.md)と日本語版(.ja.md)の 相互リンク設定と命名規則を自動適用する。
Document Generation Skill
新規ドキュメントを作成し、英日両言語版と相互リンクを設定する。
ファイル命名規則
- 英語版:
docs/{name}.md - 日本語版:
docs/{name}.ja.md
相互リンク形式
英語版の先頭(タイトル直後)
# {Title in English}
[🇯🇵 日本語版](./{name}.ja.md)
日本語版の先頭(タイトル直後)
# {日本語タイトル}
[🇺🇸 English](./{name}.md)
作成手順
- 英語版
docs/{name}.mdを作成 - 日本語版
docs/{name}.ja.mdを作成 - 両ファイルに相互リンクを追加
just lintで検証
既存ドキュメントの更新
片方のみ存在する場合、対となるファイルを作成:
.ja.mdのみ →.mdを作成(英訳).mdのみ →.ja.mdを作成(和訳)
言語別の記述ルール
英語版 (.md)
- 技術用語は一般的な英語表現を使用
- 簡潔で明確な文章
- コード例のコメントも英語
日本語版 (.ja.md)
- 技術用語はカタカナまたは原語を適宜使用
- 敬体(です・ます調)で統一
- コード例のコメントは日本語
対象外
以下は多言語の対応が不要:
docs/plans/配下の計画書.claude/配下の設定ファイルinfra/配下の README
Score
Total Score
65/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
✓最近の活動
1ヶ月以内に更新
+10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
✓タグ
1つ以上のタグが設定されている
+5
Reviews
💬
Reviews coming soon


