File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ # コーディング規約
2+
3+ ## コミットメッセージ
4+
5+ - Conventional Commits 形式を使用: ` fix: ` , ` feat: ` , ` docs: ` など
6+ - 日本語での記述を推奨
7+ - 例: ` fix: SVGとモーダルのパスを相対パスに統一 `
8+
9+ ## ブランチ運用
10+
11+ - ` main ` ブランチへの直接コミット(トランクベース開発)
12+
13+ ## ファイル命名
14+
15+ - ナレッジマップのID属性は ** ケバブケース** で統一(Figmaで管理されているSVG画像のレイヤー名として埋め込まれている)
16+ - 各ID属性に対応するMarkdownファイルは必ず ` -summary.md ` (サマリー)と ` -detail.md ` (詳細)のペアで作成
17+
18+ ## パス指定
19+
20+ - SVG やモーダルコンテンツのパスは ** 相対パス** を使用する(ローカル環境と GitHub Pages の両方で動作させるため)
Original file line number Diff line number Diff line change 1+ # モーダル実装ガイド
2+
3+ ## モーダルベースの情報開示
4+
5+ SVG ナレッジマップをクリックすると軽量なモーダルが開き、概要を表示する。
6+ 「Learn more」ボタンで詳細ページへ遷移する。ページ遷移を最小限に抑え、ブラウジング体験を重視。
7+
8+ ## デュアルコンテンツ戦略
9+
10+ 各トピックに summary(概要)と detail(詳細)の 2 ファイルを用意し、モーダルで表示する。情報の粒度を分離する。
11+
12+ ## キーボードナビゲーション
13+
14+ - 矢印キー: タブ切り替え
15+ - 数字キー(1, 2): タブジャンプ
16+ - ESC: モーダルを閉じる
17+
18+ ## 関連ファイル
19+
20+ - ` docs/javascripts/knowledge-map-modal.js ` — モーダル機能
21+ - ` docs/javascripts/navigation.js ` — タブキーボード操作
Original file line number Diff line number Diff line change 1+ # SVG ナレッジマップ規則
2+
3+ ## ID属性のプレフィックス規則
4+
5+ SVG内のID属性はFigmaで管理されており、レイヤー名として埋め込まれている。
6+
7+ - ` ifs-* ` : Instrument Flight System
8+ - ` pc-* ` : Product Core
9+ - ` pqm-* ` : Product Quality Management
10+ - ` pdm-* ` : Product Management
11+ - ` sp-* ` : Software Process
12+ - ` pjm-* ` : Project Management
13+ - ` tm-* ` : Team Management
14+ - ` pbm-* ` : Product Business Management
15+ - ` pim-* ` : Process Improvement Management
16+ - ` im-* ` : Innovation Model
17+
18+ ## ファイル構成ルール
19+
20+ ` docs/soda-knowledge-map/{topic}/ ` 配下に、各ID属性に対応するファイルをペアで作成する:
21+
22+ - ` {id}-summary.md ` — サマリー(モーダルで表示される概要)
23+ - ` {id}-detail.md ` — 詳細ページ(「Learn more」で遷移する先)
Original file line number Diff line number Diff line change @@ -58,55 +58,6 @@ mkdocs build # サイトビルド(出力先: site/)
5858└── .github/workflows/pages.yml # CI/CD
5959```
6060
61- ## コーディング規約
62-
63- ### コミットメッセージ
64-
65- - Conventional Commits 形式を使用: ` fix: ` , ` feat: ` , ` docs: ` など
66- - 日本語での記述を推奨
67- - 例: ` fix: SVGとモーダルのパスを相対パスに統一 `
68-
69- ### ブランチ運用
70-
71- - ` main ` ブランチへの直接コミット(トランクベース開発)
72-
73- ### ファイル命名
74-
75- - ナレッジマップのID属性は ** ケバブケース** で統一(Figmaで管理されているSVG画像のレイヤー名として埋め込まれている)
76- - 各ID属性に対応するMarkdownファイルは必ず ` -summary.md ` (サマリー)と ` -detail.md ` (詳細)のペアで作成
77- - ID属性のプレフィックス規則:
78- - ` ifs-* ` : Instrument Flight System
79- - ` pc-* ` : Product Core
80- - ` pqm-* ` : Product Quality Management
81- - ` pdm-* ` : Product Management
82- - ` sp-* ` : Software Process
83- - ` pjm-* ` : Project Management
84- - ` tm-* ` : Team Management
85- - ` pbm-* ` : Product Business Management
86- - ` pim-* ` : Process Improvement Management
87- - ` im-* ` : Innovation Model
88-
89- ### パス指定
90-
91- - SVG やモーダルコンテンツのパスは ** 相対パス** を使用する(ローカル環境と GitHub Pages の両方で動作させるため)
92-
93- ## 設計方針
94-
95- ### モーダルベースの情報開示
96-
97- SVG ナレッジマップをクリックすると軽量なモーダルが開き、概要を表示する。
98- 「Learn more」ボタンで詳細ページへ遷移する。ページ遷移を最小限に抑え、ブラウジング体験を重視。
99-
100- ### デュアルコンテンツ戦略
101-
102- 各トピックに summary(概要)と detail(詳細)の 2 ファイルを用意し、モーダルで表示する。情報の粒度を分離する。
103-
104- ### キーボードナビゲーション
105-
106- - 矢印キー: タブ切り替え
107- - 数字キー(1, 2): タブジャンプ
108- - ESC: モーダルを閉じる
109-
11061## やってほしいこと
11162
11263- パス指定は相対パスを使う(ローカルと GitHub Pages 両対応のため)
You can’t perform that action at this time.
0 commit comments