@k2works/claude-code-booster 6.6.0 → 6.6.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/assets/.claude/skills/apply-docs-structure/SKILL.md +3 -1
- package/lib/assets/.claude/skills/apply-docs-structure/scripts/docs_structure.py +111 -10
- package/lib/assets/.claude/skills/apply-docs-structure/templates/adr.md +12 -0
- package/lib/assets/.claude/skills/apply-docs-structure/templates/design.md +44 -0
- package/lib/assets/.claude/skills/apply-docs-structure/templates/development.md +42 -0
- package/lib/assets/.claude/skills/apply-docs-structure/templates/journal.md +12 -0
- package/lib/assets/.claude/skills/apply-docs-structure/templates/operation.md +30 -0
- package/lib/assets/.claude/skills/apply-docs-structure/templates/requirements.md +18 -0
- package/lib/assets/.claude/skills/apply-docs-structure/templates/review.md +24 -0
- package/lib/assets/docs/adr/index.md +15 -10
- package/lib/assets/docs/design/index.md +14 -44
- package/lib/assets/docs/development/index.md +18 -39
- package/lib/assets/docs/index.md +39 -37
- package/lib/assets/docs/journal/index.md +14 -0
- package/lib/assets/docs/log.md +32 -28
- package/lib/assets/docs/operation/index.md +37 -41
- package/lib/assets/docs/reference/index.md +1 -1
- package/lib/assets/docs/reference//343/203/211/343/202/255/343/203/245/343/203/241/343/203/263/343/203/210/346/247/213/346/210/220/343/202/254/343/202/244/343/203/211.md +4 -3
- package/lib/assets/docs/requirements/index.md +16 -17
- package/lib/assets/docs/review/index.md +21 -5
- package/lib/assets/mkdocs.yml +152 -151
- package/package.json +1 -1
- package/lib/assets/docs/journal/.gitkeep +0 -0
|
@@ -28,11 +28,13 @@ description: ドキュメント構成ガイド（単一企業・統合戦略・
|
|
|
28
28
|
| **add-project** | 新しいプロジェクトを始める | `apps/<project>/` とプロジェクト別 7 カテゴリの `<project>/index.md` を一括作成し、各カテゴリ索引に登録 |
|
|
29
29
|
| **check** | 上記の後、コミット前 | 構成がガイドに適合しているか検証し ERROR 0 を確認 |
|
|
30
30
|
|
|
31
|
+
add-project はカテゴリごとのテンプレート `templates/<category>.md`（`{project}` を識別子に置換）から `<project>/index.md` を作り、カテゴリ索引の「プロジェクト一覧」表に行（概要は `--description`、状況は「未着手」）を追加する。あわせて `mkdocs.yml` の nav で各カテゴリの下に `<project>:` グループ（概要: `<category>/<project>/index.md`）を追加し、サイトのナビゲーションをプロジェクト単位で折りたためるようにする（`--mkdocs` で対象ファイルを指定、`--skip mkdocs` で更新しない）。実ドキュメントを追加したら、そのグループの下に nav 項目を足す。プロジェクト索引の初期構成を変えたいときはテンプレートを編集する。
|
|
32
|
+
|
|
31
33
|
add-project と check は同梱スクリプトで行う。手で 7 カテゴリを掘らない（作成漏れ・識別子の揺れ・索引の登録漏れを起こしやすい）。
|
|
32
34
|
|
|
33
35
|
```bash
|
|
34
36
|
S=.claude/skills/apply-docs-structure/scripts/docs_structure.py
|
|
35
|
-
python $S add-project inventory-service
|
|
37
|
+
python $S add-project inventory-service --description "在庫管理システム" # docs/ と apps/ に一式作成
|
|
36
38
|
python $S add-project sales-portal --skip apps # apps を別管理している場合
|
|
37
39
|
python $S check # 検証（ERROR/WARN を列挙）
|
|
38
40
|
python $S check --check # ERROR があれば exit 1（CI・コミット前）
|
|
@@ -26,7 +26,13 @@ PER_PROJECT_CATEGORIES = {
|
|
|
26
26
|
}
|
|
27
27
|
SINGLE_CATEGORIES = ["strategy", "reference", "template", "article", "assets"]
|
|
28
28
|
PROJECT_ID_RE = re.compile(r"^[a-z0-9]+(-[a-z0-9]+)*$")
|
|
29
|
+
TEMPLATES_DIR = Path(__file__).resolve().parent.parent / "templates"
|
|
30
|
+
PROJECT_LIST_HEADING = "## プロジェクト一覧"
|
|
31
|
+
PROJECT_LIST_HEADER = "| プロジェクト | 概要 | 状況 |\n| :--- | :--- | :--- |"
|
|
32
|
+
DEFAULT_DESCRIPTION = "（概要を記入）"
|
|
33
|
+
DEFAULT_STATUS = "未着手"
|
|
29
34
|
|
|
35
|
+
# templates/<category>.md が無いカテゴリで使う汎用テンプレート
|
|
30
36
|
PROJECT_INDEX_TEMPLATE = """# {project} — {label}
|
|
31
37
|
|
|
32
38
|
{project} プロジェクトの{label}ドキュメントです。
|
|
@@ -41,6 +47,79 @@ PROJECT_INDEX_TEMPLATE = """# {project} — {label}
|
|
|
41
47
|
"""
|
|
42
48
|
|
|
43
49
|
|
|
50
|
+
def project_index_text(category: str, project: str, label: str) -> str:
|
|
51
|
+
"""templates/<category>.md（無ければ汎用テンプレート）からプロジェクト索引を作る。"""
|
|
52
|
+
template_file = TEMPLATES_DIR / f"{category}.md"
|
|
53
|
+
if template_file.is_file():
|
|
54
|
+
template = template_file.read_text(encoding="utf-8")
|
|
55
|
+
else:
|
|
56
|
+
template = PROJECT_INDEX_TEMPLATE
|
|
57
|
+
return template.replace("{project}", project).replace("{label}", label)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
def register_project(body: str, project: str, description: str) -> str:
|
|
61
|
+
"""カテゴリ索引の「プロジェクト一覧」表の末尾に行を追加する。
|
|
62
|
+
|
|
63
|
+
表が見つからなければ末尾に箇条書きで追記する。
|
|
64
|
+
"""
|
|
65
|
+
row = f"| [{project}](./{project}/index.md) | {description} | {DEFAULT_STATUS} |"
|
|
66
|
+
lines = body.split("\n")
|
|
67
|
+
try:
|
|
68
|
+
start = next(i for i, l in enumerate(lines) if l.strip() == PROJECT_LIST_HEADING)
|
|
69
|
+
except StopIteration:
|
|
70
|
+
start = None
|
|
71
|
+
if start is not None:
|
|
72
|
+
last_row = None
|
|
73
|
+
for i in range(start + 1, len(lines)):
|
|
74
|
+
if lines[i].startswith("#"):
|
|
75
|
+
break
|
|
76
|
+
if lines[i].startswith("|"):
|
|
77
|
+
last_row = i
|
|
78
|
+
elif last_row is not None:
|
|
79
|
+
break
|
|
80
|
+
if last_row is not None:
|
|
81
|
+
lines.insert(last_row + 1, row)
|
|
82
|
+
return "\n".join(lines)
|
|
83
|
+
if not body.endswith("\n"):
|
|
84
|
+
body += "\n"
|
|
85
|
+
return body + f"- [{project}](./{project}/index.md)\n"
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
def register_nav(text: str, category: str, project: str):
|
|
89
|
+
"""mkdocs.yml の nav でカテゴリ配下にプロジェクトの折りたたみグループを追加する。
|
|
90
|
+
|
|
91
|
+
カテゴリは「概要: <category>/index.md」の行で特定する。YAML のタグ
|
|
92
|
+
（!!python/name など）を壊さないよう、パースせず行単位で挿入する。
|
|
93
|
+
追加できなければ None を返す。
|
|
94
|
+
"""
|
|
95
|
+
lines = text.split("\n")
|
|
96
|
+
marker = f"{category}/index.md"
|
|
97
|
+
try:
|
|
98
|
+
overview = next(
|
|
99
|
+
i for i, l in enumerate(lines)
|
|
100
|
+
if l.strip().startswith("- ") and l.strip().endswith(marker)
|
|
101
|
+
)
|
|
102
|
+
except StopIteration:
|
|
103
|
+
return None
|
|
104
|
+
item_indent = len(lines[overview]) - len(lines[overview].lstrip())
|
|
105
|
+
# カテゴリの子要素が終わる行（インデントが子要素より浅い行）を探す
|
|
106
|
+
end = overview + 1
|
|
107
|
+
while end < len(lines):
|
|
108
|
+
line = lines[end]
|
|
109
|
+
if line.strip() and len(line) - len(line.lstrip()) < item_indent:
|
|
110
|
+
break
|
|
111
|
+
end += 1
|
|
112
|
+
while end > overview + 1 and not lines[end - 1].strip():
|
|
113
|
+
end -= 1
|
|
114
|
+
pad = " " * item_indent
|
|
115
|
+
group = [
|
|
116
|
+
f"{pad}- {project}:",
|
|
117
|
+
f"{pad} - 概要: {category}/{project}/index.md",
|
|
118
|
+
]
|
|
119
|
+
lines[end:end] = group
|
|
120
|
+
return "\n".join(lines)
|
|
121
|
+
|
|
122
|
+
|
|
44
123
|
def project_dirs(category_dir: Path):
|
|
45
124
|
"""カテゴリ直下のサブディレクトリ（= プロジェクトディレクトリ扱い）を返す。"""
|
|
46
125
|
if not category_dir.is_dir():
|
|
@@ -82,27 +161,41 @@ def cmd_add_project(args) -> int:
|
|
|
82
161
|
else:
|
|
83
162
|
proj_dir.mkdir(parents=True, exist_ok=True)
|
|
84
163
|
proj_index.write_text(
|
|
85
|
-
|
|
86
|
-
encoding="utf-8",
|
|
164
|
+
project_index_text(category, project, label), encoding="utf-8"
|
|
87
165
|
)
|
|
88
166
|
created.append(str(proj_index))
|
|
89
167
|
|
|
90
|
-
#
|
|
168
|
+
# カテゴリ索引の「プロジェクト一覧」表にエントリを追加
|
|
91
169
|
cat_index = cat_dir / "index.md"
|
|
92
|
-
|
|
170
|
+
link = f"(./{project}/index.md)"
|
|
93
171
|
if cat_index.exists():
|
|
94
172
|
body = cat_index.read_text(encoding="utf-8")
|
|
95
|
-
if
|
|
96
|
-
|
|
97
|
-
body
|
|
98
|
-
|
|
173
|
+
if link not in body:
|
|
174
|
+
cat_index.write_text(
|
|
175
|
+
register_project(body, project, args.description), encoding="utf-8"
|
|
176
|
+
)
|
|
99
177
|
created.append(f"{cat_index}（エントリ追加）")
|
|
100
178
|
else:
|
|
179
|
+
body = f"# {label}\n\n{PROJECT_LIST_HEADING}\n\n{PROJECT_LIST_HEADER}\n"
|
|
101
180
|
cat_index.write_text(
|
|
102
|
-
|
|
181
|
+
register_project(body, project, args.description), encoding="utf-8"
|
|
103
182
|
)
|
|
104
183
|
created.append(str(cat_index))
|
|
105
184
|
|
|
185
|
+
# mkdocs.yml の nav にプロジェクト単位で折りたためるグループを追加
|
|
186
|
+
mkdocs = Path(args.mkdocs)
|
|
187
|
+
if "mkdocs" not in args.skip and mkdocs.is_file():
|
|
188
|
+
text = mkdocs.read_text(encoding="utf-8")
|
|
189
|
+
if f"{category}/{project}/index.md" in text:
|
|
190
|
+
skipped.append(f"{mkdocs}（nav: {category}/{project}）")
|
|
191
|
+
else:
|
|
192
|
+
updated = register_nav(text, category, project)
|
|
193
|
+
if updated is None:
|
|
194
|
+
print(f"WARN {mkdocs}: nav に {category}/index.md が無いため {project} を追加できない")
|
|
195
|
+
else:
|
|
196
|
+
mkdocs.write_text(updated, encoding="utf-8")
|
|
197
|
+
created.append(f"{mkdocs}（nav: {category}/{project}）")
|
|
198
|
+
|
|
106
199
|
for path in created:
|
|
107
200
|
print(f"作成: {path}")
|
|
108
201
|
for path in skipped:
|
|
@@ -183,11 +276,19 @@ def main() -> int:
|
|
|
183
276
|
p_add.add_argument("project", help="プロジェクト識別子（ケバブケース）")
|
|
184
277
|
p_add.add_argument("--docs", default="docs", help="docs ディレクトリ（既定: docs）")
|
|
185
278
|
p_add.add_argument("--apps", default="apps", help="apps ディレクトリ（既定: apps）")
|
|
279
|
+
p_add.add_argument(
|
|
280
|
+
"--mkdocs", default="mkdocs.yml", help="nav を更新する mkdocs.yml（既定: mkdocs.yml、無ければ更新しない）"
|
|
281
|
+
)
|
|
282
|
+
p_add.add_argument(
|
|
283
|
+
"--description",
|
|
284
|
+
default=DEFAULT_DESCRIPTION,
|
|
285
|
+
help=f"カテゴリ索引に登録するプロジェクトの概要（既定: {DEFAULT_DESCRIPTION}）",
|
|
286
|
+
)
|
|
186
287
|
p_add.add_argument(
|
|
187
288
|
"--skip",
|
|
188
289
|
nargs="*",
|
|
189
290
|
default=[],
|
|
190
|
-
help="スキップする対象（apps
|
|
291
|
+
help="スキップする対象（apps・mkdocs・カテゴリ名）",
|
|
191
292
|
)
|
|
192
293
|
p_add.set_defaults(func=cmd_add_project)
|
|
193
294
|
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# {project} — 設計
|
|
2
|
+
|
|
3
|
+
{project} プロジェクトの設計ドキュメントです。
|
|
4
|
+
|
|
5
|
+
## ドキュメント一覧
|
|
6
|
+
|
|
7
|
+
### アーキテクチャ
|
|
8
|
+
|
|
9
|
+
| ドキュメント | 概要 | 状況 |
|
|
10
|
+
| :--- | :--- | :--- |
|
|
11
|
+
| バックエンドアーキテクチャ | バックエンドの責務分割、レイヤ、連携方式を整理 | 未作成 |
|
|
12
|
+
| フロントエンドアーキテクチャ | UI 構成、状態管理、画面遷移を整理 | 未作成 |
|
|
13
|
+
| インフラストラクチャ | 実行環境、ネットワーク、デプロイ構成を整理 | 未作成 |
|
|
14
|
+
|
|
15
|
+
### モデル設計
|
|
16
|
+
|
|
17
|
+
| ドキュメント | 概要 | 状況 |
|
|
18
|
+
| :--- | :--- | :--- |
|
|
19
|
+
| データモデル設計 | 概念・論理データモデル、テーブル定義、ER 図を整理 | 未作成 |
|
|
20
|
+
| ドメインモデル設計 | コンテキスト、集約、エンティティ、値オブジェクトを整理 | 未作成 |
|
|
21
|
+
|
|
22
|
+
### UI/UX設計
|
|
23
|
+
|
|
24
|
+
| ドキュメント | 概要 | 状況 |
|
|
25
|
+
| :--- | :--- | :--- |
|
|
26
|
+
| UI 設計 | 画面設計、画面遷移図、コンポーネント設計を整理 | 未作成 |
|
|
27
|
+
|
|
28
|
+
### 品質・運用
|
|
29
|
+
|
|
30
|
+
| ドキュメント | 概要 | 状況 |
|
|
31
|
+
| :--- | :--- | :--- |
|
|
32
|
+
| テスト戦略 | テストピラミッド、ツール、品質ゲートを整理 | 未作成 |
|
|
33
|
+
| 非機能要件 | 性能、可用性、セキュリティ、保守性、拡張性を整理 | 未作成 |
|
|
34
|
+
| 運用要件 | 監視、バックアップ、デプロイ、障害対応を整理 | 未作成 |
|
|
35
|
+
|
|
36
|
+
### その他
|
|
37
|
+
|
|
38
|
+
| ドキュメント | 概要 | 状況 |
|
|
39
|
+
| :--- | :--- | :--- |
|
|
40
|
+
| 技術スタック選定 | 技術スタック一覧とバージョン管理方針を整理 | 未作成 |
|
|
41
|
+
|
|
42
|
+
## 補足
|
|
43
|
+
|
|
44
|
+
- 実ドキュメントを追加したら、この一覧を更新します。
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# {project} — 開発
|
|
2
|
+
|
|
3
|
+
{project} プロジェクトの開発ドキュメントです。
|
|
4
|
+
|
|
5
|
+
## ドキュメント一覧
|
|
6
|
+
|
|
7
|
+
### リリース計画
|
|
8
|
+
|
|
9
|
+
| ドキュメント | 概要 | 状況 |
|
|
10
|
+
| :--- | :--- | :--- |
|
|
11
|
+
| リリース計画 | リリース全体のスコープ、スケジュール、ベロシティ、バッファ戦略 | 未作成 |
|
|
12
|
+
| 開発戦略 | 局面別の TDD アプローチ、ウォーキングスケルトン、デモ項目 | 未作成 |
|
|
13
|
+
|
|
14
|
+
### Bolt 計画
|
|
15
|
+
|
|
16
|
+
Bolt がイテレーションに当たります。ふりかえりは各 Bolt の終了報告に含めます。
|
|
17
|
+
|
|
18
|
+
| Bolt | 計画 | 終了報告 | 週 | 状態 |
|
|
19
|
+
| :--- | :--- | :--- | :--- | :--- |
|
|
20
|
+
|
|
21
|
+
Bolt を始めるときに行を追加します。
|
|
22
|
+
|
|
23
|
+
### 進捗サマリー
|
|
24
|
+
|
|
25
|
+
| 週 | 計画 SP | 実績 SP | 達成率 |
|
|
26
|
+
| :--- | ---: | ---: | ---: |
|
|
27
|
+
| **累計** | **0** | **0** | **-** |
|
|
28
|
+
|
|
29
|
+
### フェーズ進捗
|
|
30
|
+
|
|
31
|
+
| フェーズ | 内容 | SP | 完了 SP | 状態 |
|
|
32
|
+
| :--- | :--- | ---: | ---: | :--- |
|
|
33
|
+
|
|
34
|
+
### リリース完了報告書
|
|
35
|
+
|
|
36
|
+
| リリース | 報告書 | 状態 |
|
|
37
|
+
| :--- | :--- | :--- |
|
|
38
|
+
|
|
39
|
+
## 補足
|
|
40
|
+
|
|
41
|
+
- 実ドキュメントを追加したら、この一覧を更新します。
|
|
42
|
+
- 週の実績はリリース計画の進捗状況を正とします。
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# {project} — 運用
|
|
2
|
+
|
|
3
|
+
{project} プロジェクトの運用ドキュメントです。
|
|
4
|
+
|
|
5
|
+
## ドキュメント一覧
|
|
6
|
+
|
|
7
|
+
### 環境セットアップ
|
|
8
|
+
|
|
9
|
+
| ドキュメント | 概要 | 状況 |
|
|
10
|
+
| :--- | :--- | :--- |
|
|
11
|
+
| アプリケーション開発環境セットアップ手順書 | ローカルアプリケーション開発環境の構築手順 | 未作成 |
|
|
12
|
+
| 開発環境セットアップ手順書 | 開発環境のインフラ構築手順 | 未作成 |
|
|
13
|
+
| AWS ステージング環境セットアップ手順書 | ステージング環境の構築手順 | 未作成 |
|
|
14
|
+
| AWS プロダクション環境セットアップ手順書 | 本番環境の構築手順 | 未作成 |
|
|
15
|
+
|
|
16
|
+
### 運用コマンド
|
|
17
|
+
|
|
18
|
+
詳細と前提はアプリケーション開発環境セットアップ手順書を参照してください。
|
|
19
|
+
|
|
20
|
+
| コマンド | 概要 |
|
|
21
|
+
| :--- | :--- |
|
|
22
|
+
|
|
23
|
+
### インフラ
|
|
24
|
+
|
|
25
|
+
| ドキュメント | 概要 | 状況 |
|
|
26
|
+
| :--- | :--- | :--- |
|
|
27
|
+
|
|
28
|
+
## 補足
|
|
29
|
+
|
|
30
|
+
- 実ドキュメントを追加したら、この一覧を更新します。
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# {project} — 要件
|
|
2
|
+
|
|
3
|
+
{project} プロジェクトの要件ドキュメントです。
|
|
4
|
+
|
|
5
|
+
## ドキュメント一覧
|
|
6
|
+
|
|
7
|
+
| ドキュメント | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
| 要件定義 | RDRA 2.0 の 4 層でシステム価値・外部環境・境界・内部構造を整理 | 未作成 |
|
|
10
|
+
| ユースケース作成計画 | ビジネスユースケースから Unit までを段階的に作る AI-DLC の計画 | 未作成 |
|
|
11
|
+
| ビジネスユースケース | スコープ・アクター・目的・Unit の候補を整理 | 未作成 |
|
|
12
|
+
| システムユースケース | システムユースケースの目的・保証・主成功シナリオ・測定基準 | 未作成 |
|
|
13
|
+
| ユーザーストーリー | ユーザーストーリー・受入条件・上流要件へのトレーサビリティ | 未作成 |
|
|
14
|
+
| Unit 定義 | Unit の境界・依存 DAG・ユースケースとストーリーの対応 | 未作成 |
|
|
15
|
+
|
|
16
|
+
## 補足
|
|
17
|
+
|
|
18
|
+
- 実ドキュメントを追加したら、この一覧を更新します。
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# {project} — レビュー
|
|
2
|
+
|
|
3
|
+
{project} プロジェクトのレビュードキュメントです。
|
|
4
|
+
|
|
5
|
+
## ドキュメント一覧
|
|
6
|
+
|
|
7
|
+
### 分析成果物
|
|
8
|
+
|
|
9
|
+
| レビュー | 対象 | 状況 |
|
|
10
|
+
| :--- | :--- | :--- |
|
|
11
|
+
|
|
12
|
+
### 開発成果物
|
|
13
|
+
|
|
14
|
+
| レビュー | 対象 | 状況 |
|
|
15
|
+
| :--- | :--- | :--- |
|
|
16
|
+
|
|
17
|
+
### 運用成果物
|
|
18
|
+
|
|
19
|
+
| レビュー | 対象 | 状況 |
|
|
20
|
+
| :--- | :--- | :--- |
|
|
21
|
+
|
|
22
|
+
## 補足
|
|
23
|
+
|
|
24
|
+
- 実ドキュメントを追加したら、この一覧を更新します。
|
|
@@ -1,10 +1,15 @@
|
|
|
1
|
-
# ADR (Architecture Decision Records)
|
|
2
|
-
|
|
3
|
-
技術的意思決定を記録した ADR です。
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
|
8
|
-
| :--- | :--- | :--- |
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
# ADR (Architecture Decision Records)
|
|
2
|
+
|
|
3
|
+
技術的意思決定を記録した ADR です。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 補足
|
|
11
|
+
|
|
12
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
13
|
+
- 実ドキュメントは `adr/<project>/` に置き、プロジェクトの `index.md` で一覧を管理します。
|
|
14
|
+
- ADR の作成には `creating-adr` スキルを使用してください。
|
|
15
|
+
- テンプレートは [template/ADR.md](../template/ADR.md) です。
|
|
@@ -1,44 +1,14 @@
|
|
|
1
|
-
# 設計
|
|
2
|
-
|
|
3
|
-
設計ドキュメントです。要件定義に基づき、バックエンド・フロントエンド・インフラのアーキテクチャから、データモデル、ドメインモデル、UI、テスト戦略、非機能要件、運用要件まで包括的に設計しています。
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
### モデル設計
|
|
16
|
-
|
|
17
|
-
| ドキュメント | 概要 | 状況 |
|
|
18
|
-
| :--- | :--- | :--- |
|
|
19
|
-
| データモデル設計 | 概念・論理データモデル、テーブル定義、ER 図を整理 | 未作成 |
|
|
20
|
-
| ドメインモデル設計 | コンテキスト、集約、エンティティ、値オブジェクトを整理 | 未作成 |
|
|
21
|
-
|
|
22
|
-
### UI/UX設計
|
|
23
|
-
|
|
24
|
-
| ドキュメント | 概要 | 状況 |
|
|
25
|
-
| :--- | :--- | :--- |
|
|
26
|
-
| UI 設計 | 画面設計、画面遷移図、コンポーネント設計を整理 | 未作成 |
|
|
27
|
-
|
|
28
|
-
### 品質・運用
|
|
29
|
-
|
|
30
|
-
| ドキュメント | 概要 | 状況 |
|
|
31
|
-
| :--- | :--- | :--- |
|
|
32
|
-
| テスト戦略 | テストピラミッド、ツール、品質ゲートを整理 | 未作成 |
|
|
33
|
-
| 非機能要件 | 性能、可用性、セキュリティ、保守性、拡張性を整理 | 未作成 |
|
|
34
|
-
| 運用要件 | 監視、バックアップ、デプロイ、障害対応を整理 | 未作成 |
|
|
35
|
-
|
|
36
|
-
### その他
|
|
37
|
-
|
|
38
|
-
| ドキュメント | 概要 | 状況 |
|
|
39
|
-
| :--- | :--- | :--- |
|
|
40
|
-
| 技術スタック選定 | 技術スタック一覧とバージョン管理方針を整理 | 未作成 |
|
|
41
|
-
|
|
42
|
-
## 補足
|
|
43
|
-
|
|
44
|
-
- 実ドキュメントを追加したら、この一覧と `docs/index.md` を更新します。
|
|
1
|
+
# 設計
|
|
2
|
+
|
|
3
|
+
設計ドキュメントです。要件定義に基づき、バックエンド・フロントエンド・インフラのアーキテクチャから、データモデル、ドメインモデル、UI、テスト戦略、非機能要件、運用要件まで包括的に設計しています。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 補足
|
|
11
|
+
|
|
12
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
13
|
+
- 実ドキュメントは `design/<project>/` に置き、プロジェクトの `index.md` で一覧を管理します。
|
|
14
|
+
- テンプレートは [template/設計.md](../template/設計.md) を利用できます。
|
|
@@ -1,39 +1,18 @@
|
|
|
1
|
-
# 開発
|
|
2
|
-
|
|
3
|
-
開発フェーズのドキュメントです。リリース計画、イテレーション計画、ふりかえり、完了報告書を管理します。
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
### 進捗サマリー
|
|
21
|
-
|
|
22
|
-
| イテレーション | 計画 SP | 実績 SP | 達成率 |
|
|
23
|
-
|---------------|---------|---------|--------|
|
|
24
|
-
| **累計** | **0** | **0** | **-** |
|
|
25
|
-
|
|
26
|
-
### フェーズ進捗
|
|
27
|
-
|
|
28
|
-
| フェーズ | 内容 | SP | 完了 SP | 状態 |
|
|
29
|
-
|---------|------|-----|---------|------|
|
|
30
|
-
|
|
31
|
-
### リリース完了報告書
|
|
32
|
-
|
|
33
|
-
| リリース | 報告書 | 状態 |
|
|
34
|
-
|---------|--------|------|
|
|
35
|
-
|
|
36
|
-
## 補足
|
|
37
|
-
|
|
38
|
-
- 現在はカテゴリ索引のみ存在します。
|
|
39
|
-
- テンプレートは [template/リリース計画.md](../template/リリース計画.md)、[template/イテレーション計画.md](../template/イテレーション計画.md)、[template/イテレーション完了報告書.md](../template/イテレーション完了報告書.md)、[template/リリース完了報告書.md](../template/リリース完了報告書.md) を利用できます。
|
|
1
|
+
# 開発
|
|
2
|
+
|
|
3
|
+
開発フェーズのドキュメントです。リリース計画、イテレーション計画、ふりかえり、完了報告書を管理します。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 補足
|
|
11
|
+
|
|
12
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
13
|
+
- 実ドキュメントは `development/<project>/` に置き、プロジェクトの `index.md` で一覧と進捗を管理します。
|
|
14
|
+
- テンプレートは次を利用できます。
|
|
15
|
+
- [template/リリース計画.md](../template/リリース計画.md)
|
|
16
|
+
- [template/イテレーション計画.md](../template/イテレーション計画.md)
|
|
17
|
+
- [template/イテレーション完了報告書.md](../template/イテレーション完了報告書.md)
|
|
18
|
+
- [template/リリース完了報告書.md](../template/リリース完了報告書.md)
|
package/lib/assets/docs/index.md
CHANGED
|
@@ -1,37 +1,39 @@
|
|
|
1
|
-
---
|
|
2
|
-
okf_version: "0.2"
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# プロジェクトドキュメント
|
|
6
|
-
|
|
7
|
-
プロジェクトで管理しているドキュメントの入口です。
|
|
8
|
-
|
|
9
|
-
## まずこれを読もうリスト
|
|
10
|
-
|
|
11
|
-
- [戦略](./strategy/index.md) - ビジネス構造やプロジェクトの方向性を整理します。
|
|
12
|
-
- [要件](./requirements/index.md) - RDRA 2.0 ベースで要件を定義します。
|
|
13
|
-
- [設計](./design/index.md) - アーキテクチャ、モデル、品質方針を整理します。
|
|
14
|
-
- [開発](./development/index.md) - リリース計画とイテレーション管理の入口です。
|
|
15
|
-
- [運用](./operation/index.md) - 環境構築、デプロイ、運用関連の入口です。
|
|
16
|
-
- [記事](./article/index.md) - 学習用の記事シリーズの入口です。
|
|
17
|
-
|
|
18
|
-
## ドキュメント構成
|
|
19
|
-
|
|
20
|
-
| カテゴリ | 概要 | 状況 |
|
|
21
|
-
| :--- |:------------------------------------| :--- |
|
|
22
|
-
| [戦略](./strategy/index.md) | 企業分析、経営戦略、ビジネスアーキテクチャ、インセプションデッキの整理 | `index.md` を整備済み |
|
|
23
|
-
| [要件](./requirements/index.md) | RDRA 2.0 とユースケース整理の入口 | `index.md` を整備済み |
|
|
24
|
-
| [設計](./design/index.md) | アーキテクチャ、モデル、テスト、非機能の整理 | `index.md` を整備済み |
|
|
25
|
-
| [開発](./development/index.md) | リリース計画、イテレーション計画、進捗管理 | `index.md` を整備済み |
|
|
26
|
-
| [運用](./operation/index.md) | 環境構築、デプロイ、運用手順の整理 | `index.md` を整備済み |
|
|
27
|
-
| [レビュー](./review/index.md) | 分析・開発レビュー結果の記録 | `index.md` を整備済み |
|
|
28
|
-
| [ADR](./adr/index.md) | Architecture Decision Records の管理 | `index.md` を整備済み |
|
|
29
|
-
| [
|
|
30
|
-
| [
|
|
31
|
-
| [
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
- `
|
|
37
|
-
- `
|
|
1
|
+
---
|
|
2
|
+
okf_version: "0.2"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# プロジェクトドキュメント
|
|
6
|
+
|
|
7
|
+
プロジェクトで管理しているドキュメントの入口です。
|
|
8
|
+
|
|
9
|
+
## まずこれを読もうリスト
|
|
10
|
+
|
|
11
|
+
- [戦略](./strategy/index.md) - ビジネス構造やプロジェクトの方向性を整理します。
|
|
12
|
+
- [要件](./requirements/index.md) - RDRA 2.0 ベースで要件を定義します。
|
|
13
|
+
- [設計](./design/index.md) - アーキテクチャ、モデル、品質方針を整理します。
|
|
14
|
+
- [開発](./development/index.md) - リリース計画とイテレーション管理の入口です。
|
|
15
|
+
- [運用](./operation/index.md) - 環境構築、デプロイ、運用関連の入口です。
|
|
16
|
+
- [記事](./article/index.md) - 学習用の記事シリーズの入口です。
|
|
17
|
+
|
|
18
|
+
## ドキュメント構成
|
|
19
|
+
|
|
20
|
+
| カテゴリ | 概要 | 状況 |
|
|
21
|
+
| :--- |:------------------------------------| :--- |
|
|
22
|
+
| [戦略](./strategy/index.md) | 企業分析、経営戦略、ビジネスアーキテクチャ、インセプションデッキの整理 | `index.md` を整備済み |
|
|
23
|
+
| [要件](./requirements/index.md) | RDRA 2.0 とユースケース整理の入口 | `index.md` を整備済み |
|
|
24
|
+
| [設計](./design/index.md) | アーキテクチャ、モデル、テスト、非機能の整理 | `index.md` を整備済み |
|
|
25
|
+
| [開発](./development/index.md) | リリース計画、イテレーション計画、進捗管理 | `index.md` を整備済み |
|
|
26
|
+
| [運用](./operation/index.md) | 環境構築、デプロイ、運用手順の整理 | `index.md` を整備済み |
|
|
27
|
+
| [レビュー](./review/index.md) | 分析・開発レビュー結果の記録 | `index.md` を整備済み |
|
|
28
|
+
| [ADR](./adr/index.md) | Architecture Decision Records の管理 | `index.md` を整備済み |
|
|
29
|
+
| [ジャーナル](./journal/index.md) | 開発ジャーナル（判断と学びの記録） | `index.md` を整備済み |
|
|
30
|
+
| [記事](./article/index.md) | 学習用の記事シリーズ一覧 | 公開サイトへのリンク集 |
|
|
31
|
+
| [リファレンス](./reference/index.md) | 開発ガイドラインやベストプラクティス | 39 件のドキュメントを配置 |
|
|
32
|
+
| [テンプレート](./template/index.md) | 各種ドキュメントの作成テンプレート | 18 件のテンプレートを配置 |
|
|
33
|
+
|
|
34
|
+
## 補足
|
|
35
|
+
|
|
36
|
+
- `strategy/` は企業で 1 つの統合戦略として管理し、プロジェクト別のサブディレクトリは作りません。
|
|
37
|
+
- `requirements/`、`design/`、`development/`、`operation/`、`adr/`、`journal/`、`review/` はプロジェクト別に管理します。カテゴリ直下の `index.md` はプロジェクト一覧の索引で、実ドキュメントとその一覧は `<category>/<project>/index.md` 配下に置きます。
|
|
38
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行います。構成の規約は [ドキュメント構成ガイド](./reference/ドキュメント構成ガイド.md) を参照してください。
|
|
39
|
+
- `assets/` は MkDocs 用のスタイル・スクリプトを格納しています。
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# ジャーナル
|
|
2
|
+
|
|
3
|
+
開発ジャーナル（判断と学びの記録）です。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 補足
|
|
11
|
+
|
|
12
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
13
|
+
- 実ドキュメントは `journal/<project>/` に置き、プロジェクトの `index.md` で一覧を管理します。
|
|
14
|
+
- ジャーナルの作成には `creating-journal` スキルを使用してください。
|
package/lib/assets/docs/log.md
CHANGED
|
@@ -1,28 +1,32 @@
|
|
|
1
|
-
# Docs Update Log
|
|
2
|
-
|
|
3
|
-
## 2026-
|
|
4
|
-
* **
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
* **
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
* **Verification**: [
|
|
12
|
-
* **Verification**: [
|
|
13
|
-
* **
|
|
14
|
-
* **
|
|
15
|
-
* **
|
|
16
|
-
* **
|
|
17
|
-
* **Creation**: [
|
|
18
|
-
* **
|
|
19
|
-
* **Creation**: [AI-DLC
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
* **
|
|
23
|
-
* **
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
* **Update**:
|
|
28
|
-
* **
|
|
1
|
+
# Docs Update Log
|
|
2
|
+
|
|
3
|
+
## 2026-10-03
|
|
4
|
+
* **Update**: プロジェクト別 7 カテゴリ（requirements/design/development/operation/adr/journal/review）のカテゴリ索引を「プロジェクト一覧」表の形式に変更し、ドキュメント一覧は `apply-docs-structure` のテンプレートから作る `<category>/<project>/index.md` に移動。[ジャーナル](/journal/index.md) の索引を新規作成し、[ドキュメント構成ガイド](/reference/ドキュメント構成ガイド.md) の追加手順を更新（claude-code/claude-opus-5-5）
|
|
5
|
+
* **Update**: MkDocs のナビゲーションをプロジェクト単位で折りたためるように変更（`navigation.sections` を外し、add-project が nav にプロジェクトのグループを追加）。[ドキュメント構成ガイド](/reference/ドキュメント構成ガイド.md) に nav の規約を追記（claude-code/claude-opus-5-5）
|
|
6
|
+
|
|
7
|
+
## 2026-09-26
|
|
8
|
+
* **Creation**: [BDD導入ガイド](/reference/BDD導入ガイド.md) を作成（claude-code/claude-opus-5）
|
|
9
|
+
|
|
10
|
+
## 2026-09-12
|
|
11
|
+
* **Verification**: [AI-DLC用語集](/reference/AI-DLC用語集.md) を human:kakimomokuri が検証
|
|
12
|
+
* **Verification**: [コーディングとテストガイド_AI-DLC版](/reference/コーディングとテストガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
13
|
+
* **Verification**: [ユースケース作成ガイド_AI-DLC版](/reference/ユースケース作成ガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
14
|
+
* **Verification**: [リリース・イテレーション計画ガイド_AI-DLC版](/reference/リリース・イテレーション計画ガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
15
|
+
* **Verification**: [開発ガイド_AI-DLC版](/reference/開発ガイド_AI-DLC版.md) を human:kakimomokuri が検証
|
|
16
|
+
* **Verification**: [AI-DLC導入ガイド](/reference/AI-DLC導入ガイド.md) を human:kakimomokuri が検証
|
|
17
|
+
* **Creation**: [AI-DLC 用語集](/reference/AI-DLC用語集.md) を新規作成。論文・参照実装・本プロジェクトの AI-DLC 版ガイドの用語を 6 区分で定義し、XP・Scrum との対応表と参照先を追加。`CLAUDE.md` の参照表にも登録。
|
|
18
|
+
* **Creation**: [開発ガイド（AI-DLC 版）](/reference/開発ガイド_AI-DLC版.md) を新規作成。XP 版の開発ライフサイクル（分析・開発・運用・構築・配置）を AI-DLC の 3 フェーズで読み替え、各活動で AI が生成し人が検証するものを定義。AI-DLC 版ガイド 4 本と XP 版ガイドの対応表を追加。あわせて `CLAUDE.md` に AI-DLC を採用する旨と守るべき 6 原則を明記し、ペルソナの参照先を開発ガイド（AI-DLC 版）に変更。
|
|
19
|
+
* **Creation**: [コーディングとテストガイド（AI-DLC 版）](/reference/コーディングとテストガイド_AI-DLC版.md) を新規作成。XP 版の章構成を保ちながら、TDD の三原則を AI に守らせる Bolt 開発フロー、承認ゲートの密度選択、AI 向けのアプローチ指示、ステップ計画、Red/Green/Refactor 各フェーズの人の検証観点、AI 生成コード固有の品質観点、ソース束縛レビュー、テスト戦略の水準、ガードレール化、quick-cement としての技術的負債、開発スキルの読み替え表を定義。
|
|
20
|
+
* **Creation**: [ユースケース作成ガイド（AI-DLC 版）](/reference/ユースケース作成ガイド_AI-DLC版.md) を新規作成。XP 版の章構成を保ちながら、Mob Elaboration によるユースケース作成手順、12 ステップの AI と人の分担、トレーサビリティ項目を加えたテンプレート、セマンティクス密度、AI 生成ユースケースの検証観点、ブラウンフィールドのリバースエンジニアリング、プロンプトパターン、分析スキルの読み替え表を定義。
|
|
21
|
+
* **Creation**: [リリース・イテレーション計画ガイド（AI-DLC 版）](/reference/リリース・イテレーション計画ガイド_AI-DLC版.md) を新規作成。XP 版の章構成を保ちながら、Intent → Unit → Bolt の計画階層、承認駆動の Bolt 計画、エントロピー評価による見積もり、完了 Unit 数・ゲート通過数・リードタイムによる進捗管理、リスク台帳、Bolt 終了報告テンプレート、計画スキルの読み替え表を定義。
|
|
22
|
+
* **Update**: [AI-DLC 導入ガイド](/reference/AI-DLC導入ガイド.md) を一次情報（Method Definition Paper・aidlc-workflows ユーザーガイド）で精査し拡充。10 の基本原則、成果物定義（Intent・Unit・Bolt・Domain/Logical Design・Deployment Unit）、Inception の 6 成果物、グリーンフィールド／ブラウンフィールド実践例、付録 A のプロンプトパターン、参照実装の 5 フェーズ 33 ステージ・スコープ・エージェント・承認ゲート・監査ログ、33 ステージと Skills の対応表を追加。
|
|
23
|
+
* **Creation**: [AI-DLC 導入ガイド](/reference/AI-DLC導入ガイド.md) を新規作成。AI-DLC の概要・コア原則・3 フェーズ・ベストプラクティスを整理し、XP と Skills 体系への対応表と段階的な導入ステップを定義。
|
|
24
|
+
|
|
25
|
+
## 2026-08-26
|
|
26
|
+
* **Verification**: [ドキュメント構成ガイド](/reference/ドキュメント構成ガイド.md) を human:kakimomokuri が検証
|
|
27
|
+
* **Update**: ドキュメント構成ガイドを更新。docs/review を共通からプロジェクト別カテゴリに変更（プロジェクト別は 7 カテゴリに）。
|
|
28
|
+
* **Creation**: ドキュメント構成ガイドを新規作成。単一企業・統合戦略・複数プロジェクトのコンセプトと apps/ との対応規約を定義。
|
|
29
|
+
|
|
30
|
+
## 2026-08-25
|
|
31
|
+
* **Update**: リンク切れ 53 件を修正。`grokking-concurrency` のサンプルコード参照をインラインコード表記に統一、`functional-desgin-ppp/elixir` の目次 6〜10 章を実際の章構成に合わせて書き直し、[Codex CLI MCP アプリケーション開発フロー](/reference/CodexCLIMCPアプリケーション開発フロー.md) の関連ドキュメントを実在ガイドに付け替え、未執筆の付録は「未作成」と明記。`template/まずこれを読もうリスト.md` の 10 件はコピー先基準のパスのため据え置き。
|
|
32
|
+
* **Migration**: `docs/` を OKF v0.2 の知識バンドルに移行。601 件のコンセプト（Article 552 件・Reference 31 件・Template 18 件）に `type`・`title`・`description`・`tags`・`generated` を付与し、ルート `index.md` に `okf_version: "0.2"` を宣言。本文は変更していない。Wiki.js 由来のフロントマターは OKF 形式に併合した。
|
|
@@ -1,41 +1,37 @@
|
|
|
1
|
-
# 運用
|
|
2
|
-
|
|
3
|
-
開発環境構築・デプロイ・運用に関するドキュメントです。
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
`
|
|
21
|
-
|
|
22
|
-
|
|
|
23
|
-
|
|
|
24
|
-
| `gulp okf:
|
|
25
|
-
| `gulp okf:
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
## 補足
|
|
39
|
-
|
|
40
|
-
- 現在はカテゴリ索引のみ存在します。
|
|
41
|
-
- テンプレートは [template/アプリケーション開発環境セットアップ手順書.md](../template/アプリケーション開発環境セットアップ手順書.md)、[template/開発環境セットアップ手順書.md](../template/開発環境セットアップ手順書.md)、[template/AWSステージング環境セットアップ手順書.md](../template/AWSステージング環境セットアップ手順書.md)、[template/AWSプロダクション環境セットアップ手順書.md](../template/AWSプロダクション環境セットアップ手順書.md) を利用できます。
|
|
1
|
+
# 運用
|
|
2
|
+
|
|
3
|
+
開発環境構築・デプロイ・運用に関するドキュメントです。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 共通の運用コマンド
|
|
11
|
+
|
|
12
|
+
### OKF（知識バンドル）
|
|
13
|
+
|
|
14
|
+
`docs/` は OKF v0.2 の知識バンドルです（[OKF 導入ガイド](../reference/OKF導入ガイド_V0.2.md)）。
|
|
15
|
+
移行・検証は `migrating-okf` スキル、日常の運用は以下の Gulp タスクを使います。
|
|
16
|
+
|
|
17
|
+
| コマンド | 概要 |
|
|
18
|
+
| :--- | :--- |
|
|
19
|
+
| `gulp okf:check` | バンドルの適合性を検証する。ERROR があれば非ゼロ終了 |
|
|
20
|
+
| `gulp okf:upgrade` | 仕様バージョンへ追従する（`OKF_VERSION`、`OKF_DRY_RUN=1` で試行） |
|
|
21
|
+
| `gulp okf:setup` | 上流ツール `reference_agent` を `tmp/open-knowledge-format` にクローン・インストール |
|
|
22
|
+
| `gulp okf:viz` | バンドルをグラフ HTML に可視化する（既定 `tmp/okf/viz.html`） |
|
|
23
|
+
| `gulp okf:viz:open` | 可視化 HTML をブラウザで開く |
|
|
24
|
+
| `gulp okf:enrich` | BigQuery データセットからバンドルを生成する（要 GCP 認証・`OKF_DATASET`） |
|
|
25
|
+
| `gulp okf:help` | タスクと環境変数の一覧 |
|
|
26
|
+
|
|
27
|
+
環境変数は `.env.example` の OKF セクションを参照してください。プロジェクト固有の運用コマンドは各プロジェクトの `index.md` に記載します。
|
|
28
|
+
|
|
29
|
+
## 補足
|
|
30
|
+
|
|
31
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
32
|
+
- 実ドキュメントは `operation/<project>/` に置き、プロジェクトの `index.md` で一覧を管理します。
|
|
33
|
+
- テンプレートは次を利用できます。
|
|
34
|
+
- [template/アプリケーション開発環境セットアップ手順書.md](../template/アプリケーション開発環境セットアップ手順書.md)
|
|
35
|
+
- [template/開発環境セットアップ手順書.md](../template/開発環境セットアップ手順書.md)
|
|
36
|
+
- [template/AWSステージング環境セットアップ手順書.md](../template/AWSステージング環境セットアップ手順書.md)
|
|
37
|
+
- [template/AWSプロダクション環境セットアップ手順書.md](../template/AWSプロダクション環境セットアップ手順書.md)
|
|
@@ -95,7 +95,7 @@ apps/
|
|
|
95
95
|
|
|
96
96
|
```text
|
|
97
97
|
docs/<category>/
|
|
98
|
-
├── index.md #
|
|
98
|
+
├── index.md # カテゴリ索引：プロジェクト一覧の表
|
|
99
99
|
├── project-a/
|
|
100
100
|
│ ├── index.md # プロジェクト A のカテゴリ内の入口
|
|
101
101
|
│ └── *.md # 実ドキュメント
|
|
@@ -133,8 +133,9 @@ docs/<category>/
|
|
|
133
133
|
|
|
134
134
|
1. プロジェクト識別子を決めます（命名規約に従う）。
|
|
135
135
|
2. `apps/<project>/` を作成し、アプリケーションの雛形を配置します。
|
|
136
|
-
3. プロジェクト別 7 カテゴリに `<project>/index.md`
|
|
137
|
-
4. 各カテゴリ直下の `index.md`
|
|
136
|
+
3. プロジェクト別 7 カテゴリに `<project>/index.md` を作成します。`apply-docs-structure` スキルの add-project を使うと、カテゴリごとのテンプレート（`.claude/skills/apply-docs-structure/templates/<category>.md`）から、ドキュメント一覧の表（未作成の行）を備えた索引が作られます。
|
|
137
|
+
4. 各カテゴリ直下の `index.md` の「プロジェクト一覧」表にプロジェクトの行（プロジェクト・概要・状況）を追加します。add-project は `--description` の概要と状況「未着手」で行を追加します。
|
|
138
|
+
- MkDocs のナビゲーション（`mkdocs.yml` の nav）は、各カテゴリの下にプロジェクトのグループを置き、プロジェクト単位で折りたためるようにします。add-project がグループと概要の項目を追加するので、実ドキュメントはそのグループの下に追加します。
|
|
138
139
|
5. `apply-okf` スキルでフロントマター付与・`docs/log.md` への記録・適合性検証を行います。
|
|
139
140
|
|
|
140
141
|
## 補足
|
|
@@ -1,17 +1,16 @@
|
|
|
1
|
-
# 要件
|
|
2
|
-
|
|
3
|
-
RDRA 2.0 に基づく要件定義ドキュメントです。
|
|
4
|
-
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
|
|
|
8
|
-
| :--- | :--- | :--- |
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
- テンプレートは [template/要件定義.md](../template/要件定義.md) と [template/完全形式のユースケース.md](../template/完全形式のユースケース.md) を利用できます。
|
|
1
|
+
# 要件
|
|
2
|
+
|
|
3
|
+
RDRA 2.0 に基づく要件定義ドキュメントです。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 補足
|
|
11
|
+
|
|
12
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
13
|
+
- 実ドキュメントは `requirements/<project>/` に置き、プロジェクトの `index.md` で一覧を管理します。
|
|
14
|
+
- テンプレートは次を利用できます。
|
|
15
|
+
- [template/要件定義.md](../template/要件定義.md)
|
|
16
|
+
- [template/完全形式のユースケース.md](../template/完全形式のユースケース.md)
|
|
@@ -1,5 +1,21 @@
|
|
|
1
|
-
# レビュー
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
##
|
|
1
|
+
# レビュー
|
|
2
|
+
|
|
3
|
+
分析・開発・運用成果物に対するレビュー結果を管理します。
|
|
4
|
+
|
|
5
|
+
## プロジェクト一覧
|
|
6
|
+
|
|
7
|
+
| プロジェクト | 概要 | 状況 |
|
|
8
|
+
| :--- | :--- | :--- |
|
|
9
|
+
|
|
10
|
+
## 共通のレビュー
|
|
11
|
+
|
|
12
|
+
`strategy/` など、プロジェクトに属さない成果物のレビューはこのディレクトリ直下に置きます。
|
|
13
|
+
|
|
14
|
+
| レビュー | 対象 | 判定 |
|
|
15
|
+
| :--- | :--- | :--- |
|
|
16
|
+
|
|
17
|
+
## 補足
|
|
18
|
+
|
|
19
|
+
- プロジェクトの追加は `apply-docs-structure` スキル（add-project）で行い、この一覧と `docs/index.md` を更新します。
|
|
20
|
+
- プロジェクトの成果物のレビューは `review/<project>/` に置き、プロジェクトの `index.md` で一覧を管理します。
|
|
21
|
+
- レビューは `analyzing-review`・`developing-review`・`developing-uiux-review`・`operating-review` スキルで行います。
|
package/lib/assets/mkdocs.yml
CHANGED
|
@@ -1,151 +1,152 @@
|
|
|
1
|
-
site_name: Site Name
|
|
2
|
-
site_description: Site Description
|
|
3
|
-
site_author: Project Team
|
|
4
|
-
repo_url: https://github.com/k2works/claude-code-booster
|
|
5
|
-
repo_name: claude-code-booster
|
|
6
|
-
|
|
7
|
-
theme:
|
|
8
|
-
name: material
|
|
9
|
-
palette:
|
|
10
|
-
primary: indigo
|
|
11
|
-
accent: indigo
|
|
12
|
-
features:
|
|
13
|
-
- navigation.tabs
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
- search.
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
- pymdownx.
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
- pymdownx.
|
|
35
|
-
- pymdownx.
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
-
|
|
93
|
-
- AI-DLC
|
|
94
|
-
- AI-DLC
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
-
|
|
116
|
-
-
|
|
117
|
-
-
|
|
118
|
-
-
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
-
|
|
127
|
-
- Codex CLI MCP
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
-
|
|
131
|
-
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
-
|
|
135
|
-
-
|
|
136
|
-
-
|
|
137
|
-
-
|
|
138
|
-
-
|
|
139
|
-
-
|
|
140
|
-
-
|
|
141
|
-
-
|
|
142
|
-
-
|
|
143
|
-
-
|
|
144
|
-
-
|
|
145
|
-
-
|
|
146
|
-
-
|
|
147
|
-
-
|
|
148
|
-
- AWS
|
|
149
|
-
-
|
|
150
|
-
-
|
|
151
|
-
-
|
|
1
|
+
site_name: Site Name
|
|
2
|
+
site_description: Site Description
|
|
3
|
+
site_author: Project Team
|
|
4
|
+
repo_url: https://github.com/k2works/claude-code-booster
|
|
5
|
+
repo_name: claude-code-booster
|
|
6
|
+
|
|
7
|
+
theme:
|
|
8
|
+
name: material
|
|
9
|
+
palette:
|
|
10
|
+
primary: indigo
|
|
11
|
+
accent: indigo
|
|
12
|
+
features:
|
|
13
|
+
- navigation.tabs
|
|
14
|
+
- toc.integrate
|
|
15
|
+
- search.suggest
|
|
16
|
+
- search.highlight
|
|
17
|
+
|
|
18
|
+
extra_css:
|
|
19
|
+
- assets/css/extra.css
|
|
20
|
+
|
|
21
|
+
markdown_extensions:
|
|
22
|
+
- pymdownx.arithmatex:
|
|
23
|
+
generic: true
|
|
24
|
+
- pymdownx.highlight
|
|
25
|
+
- pymdownx.superfences:
|
|
26
|
+
custom_fences:
|
|
27
|
+
- name: mermaid
|
|
28
|
+
class: mermaid
|
|
29
|
+
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
30
|
+
- name: plantuml
|
|
31
|
+
class: plantuml
|
|
32
|
+
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
33
|
+
- pymdownx.tabbed
|
|
34
|
+
- pymdownx.tasklist
|
|
35
|
+
- pymdownx.emoji
|
|
36
|
+
- admonition
|
|
37
|
+
- toc:
|
|
38
|
+
permalink: true
|
|
39
|
+
- plantuml_markdown:
|
|
40
|
+
server: !!python/object/apply:os.getenv
|
|
41
|
+
- PLANTUML_SERVER_URL
|
|
42
|
+
- http://www.plantuml.com/plantuml
|
|
43
|
+
format: svg
|
|
44
|
+
- pymdownx.tasklist:
|
|
45
|
+
custom_checkbox: true
|
|
46
|
+
- attr_list
|
|
47
|
+
|
|
48
|
+
extra_javascript:
|
|
49
|
+
- https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js
|
|
50
|
+
- assets/js/extra.js
|
|
51
|
+
# 数式（MathJax 3）。設定を先に読み込んでから MathJax 本体を読み込む
|
|
52
|
+
- assets/js/mathjax.js
|
|
53
|
+
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
|
|
54
|
+
|
|
55
|
+
extra:
|
|
56
|
+
plantuml_url: http://www.plantuml.com/plantuml
|
|
57
|
+
social:
|
|
58
|
+
- icon: fontawesome/brands/github
|
|
59
|
+
link: https://github.com/k2works
|
|
60
|
+
name: GitHub Repository/claude-code-booster
|
|
61
|
+
|
|
62
|
+
plugins:
|
|
63
|
+
- search
|
|
64
|
+
|
|
65
|
+
exclude_docs: |
|
|
66
|
+
wiki
|
|
67
|
+
|
|
68
|
+
nav:
|
|
69
|
+
- Home: index.md
|
|
70
|
+
- 戦略:
|
|
71
|
+
- 概要: strategy/index.md
|
|
72
|
+
- 要件:
|
|
73
|
+
- 概要: requirements/index.md
|
|
74
|
+
- 設計:
|
|
75
|
+
- 概要: design/index.md
|
|
76
|
+
- 開発:
|
|
77
|
+
- 概要: development/index.md
|
|
78
|
+
- 運用:
|
|
79
|
+
- 概要: operation/index.md
|
|
80
|
+
- レビュー:
|
|
81
|
+
- 概要: review/index.md
|
|
82
|
+
- ADR:
|
|
83
|
+
- 概要: adr/index.md
|
|
84
|
+
- ジャーナル:
|
|
85
|
+
- 概要: journal/index.md
|
|
86
|
+
- 記事:
|
|
87
|
+
- 概要: article/index.md
|
|
88
|
+
- リファレンス:
|
|
89
|
+
- 概要: reference/index.md
|
|
90
|
+
- よいソフトウェアとは: reference/よいソフトウェアとは.md
|
|
91
|
+
- ロジカルシンキング: reference/ロジカルシンキング.md
|
|
92
|
+
- 開発ガイド: reference/開発ガイド.md
|
|
93
|
+
- 開発ガイド（AI-DLC 版）: reference/開発ガイド_AI-DLC版.md
|
|
94
|
+
- AI-DLC 導入ガイド: reference/AI-DLC導入ガイド.md
|
|
95
|
+
- AI-DLC 用語集: reference/AI-DLC用語集.md
|
|
96
|
+
- ドキュメント構成ガイド: reference/ドキュメント構成ガイド.md
|
|
97
|
+
- Living Documentation 導入ガイド: reference/LivingDocumentation導入ガイド.md
|
|
98
|
+
- アノテーション導入ガイド: reference/アノテーション導入ガイド.md
|
|
99
|
+
- ダイナミックキュレーション導入ガイド: reference/ダイナミックキュレーション導入ガイド.md
|
|
100
|
+
- ガイドツアー・サイトシーイング導入ガイド: reference/ガイドツアー・サイトシーイング導入ガイド.md
|
|
101
|
+
- OKF 導入ガイド（Open Knowledge Format v0.2）: reference/OKF導入ガイド_V0.2.md
|
|
102
|
+
- 経営戦略分析ガイド: reference/経営戦略分析ガイド.md
|
|
103
|
+
- ビジネスアーキテクチャ分析ガイド: reference/ビジネスアーキテクチャ分析ガイド.md
|
|
104
|
+
- 要件定義ガイド: reference/要件定義ガイド.md
|
|
105
|
+
- ユースケース作成ガイド: reference/ユースケース作成ガイド.md
|
|
106
|
+
- ユースケース作成ガイド（AI-DLC 版）: reference/ユースケース作成ガイド_AI-DLC版.md
|
|
107
|
+
- アーキテクチャ設計ガイド: reference/アーキテクチャ設計ガイド.md
|
|
108
|
+
- データモデル設計ガイド: reference/データモデル設計ガイド.md
|
|
109
|
+
- ドメインモデル設計ガイド: reference/ドメインモデル設計ガイド.md
|
|
110
|
+
- UI 設計ガイド: reference/UI設計ガイド.md
|
|
111
|
+
- テスト戦略ガイド: reference/テスト戦略ガイド.md
|
|
112
|
+
- 非機能要件定義ガイド: reference/非機能要件定義ガイド.md
|
|
113
|
+
- 運用要件定義ガイド: reference/運用要件定義ガイド.md
|
|
114
|
+
- インフラ設計ガイド: reference/インフラ設計ガイド.md
|
|
115
|
+
- コーディングとテストガイド: reference/コーディングとテストガイド.md
|
|
116
|
+
- コーディングとテストガイド（AI-DLC 版）: reference/コーディングとテストガイド_AI-DLC版.md
|
|
117
|
+
- BDD 導入ガイド: reference/BDD導入ガイド.md
|
|
118
|
+
- エクストリームプログラミング: reference/エクストリームプログラミング.md
|
|
119
|
+
- リリースガイド: reference/リリースガイド.md
|
|
120
|
+
- リリース・イテレーション計画ガイド: reference/リリース・イテレーション計画ガイド.md
|
|
121
|
+
- リリース・イテレーション計画ガイド（AI-DLC 版）: reference/リリース・イテレーション計画ガイド_AI-DLC版.md
|
|
122
|
+
- 環境変数管理ガイド: reference/環境変数管理ガイド.md
|
|
123
|
+
- 言語別開発ガイド: reference/言語別開発ガイド.md
|
|
124
|
+
- Java アプリケーション環境構築ガイド: reference/Javaアプリケーション環境構築ガイド.md
|
|
125
|
+
- TypeScript アプリケーション環境構築ガイド: reference/TypeScriptアプリケーション環境構築ガイド.md
|
|
126
|
+
- 運用スクリプト作成ガイド: reference/運用スクリプト作成ガイド.md
|
|
127
|
+
- Codex CLI MCP アプリケーション開発フロー: reference/CodexCLIMCPアプリケーション開発フロー.md
|
|
128
|
+
- Codex CLI MCP サーバー設定手順: reference/CodexCLIMCPサーバー設定手順.md
|
|
129
|
+
- SonarQube ローカル環境セットアップ手順書: reference/SonarQubeローカル環境セットアップ手順書.md
|
|
130
|
+
- Vim 操作マニュアル: reference/Vim操作マニュアル.md
|
|
131
|
+
- 企業経営論: reference/企業経営論.md
|
|
132
|
+
- 運営管理: reference/運営管理.md
|
|
133
|
+
- テンプレート:
|
|
134
|
+
- 概要: template/index.md
|
|
135
|
+
- まずこれを読もうリスト: template/まずこれを読もうリスト.md
|
|
136
|
+
- ビジネスアーキテクチャ: template/ビジネスアーキテクチャ.md
|
|
137
|
+
- 要件定義: template/要件定義.md
|
|
138
|
+
- 完全形式のユースケース: template/完全形式のユースケース.md
|
|
139
|
+
- 設計: template/設計.md
|
|
140
|
+
- ADR: template/ADR.md
|
|
141
|
+
- インセプションデッキ: template/インセプションデッキ.md
|
|
142
|
+
- イテレーション計画: template/イテレーション計画.md
|
|
143
|
+
- イテレーション完了報告書: template/イテレーション完了報告書.md
|
|
144
|
+
- リリース計画: template/リリース計画.md
|
|
145
|
+
- リリース完了報告書: template/リリース完了報告書.md
|
|
146
|
+
- アプリケーション開発環境セットアップ手順書: template/アプリケーション開発環境セットアップ手順書.md
|
|
147
|
+
- 開発環境セットアップ手順書: template/開発環境セットアップ手順書.md
|
|
148
|
+
- AWS ステージング環境セットアップ手順書: template/AWSステージング環境セットアップ手順書.md
|
|
149
|
+
- AWS プロダクション環境セットアップ手順書: template/AWSプロダクション環境セットアップ手順書.md
|
|
150
|
+
- 企業分析: template/企業分析.md
|
|
151
|
+
- 事例分析: template/事例分析.md
|
|
152
|
+
- README: template/README.md
|
package/package.json
CHANGED
|
File without changes
|