create-specment 0.4.1 → 0.5.0
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/README.md +1 -1
- package/package.json +6 -6
- package/templates/docs/01-overview/as-is.mdx +2 -2
- package/templates/docs/01-overview/glossary.mdx +2 -2
- package/templates/docs/01-overview/odsc.mdx +2 -2
- package/templates/docs/01-overview/swot-analysis.mdx +13 -13
- package/templates/docs/01-overview/to-be.mdx +2 -2
- package/templates/docs/02-requirements/functional/_category_.yaml +5 -0
- package/templates/docs/02-requirements/functional/_req-template.mdx +7 -7
- package/templates/docs/02-requirements/functional/req-001.mdx +3 -2
- package/templates/docs/02-requirements/non-functional/_category_.yaml +5 -0
- package/templates/docs/02-requirements/non-functional/_nfr-template.mdx +6 -6
- package/templates/docs/03-external/business-model.mdx +1 -1
- package/templates/docs/03-external/index.mdx +1 -1
- package/templates/docs/04-internal/batches/import-products.mdx +1 -1
- package/templates/docs/04-internal/policies/claude.mdx +91 -0
- package/templates/docs/04-internal/policies/github.mdx +6 -8
- package/templates/docs/04-internal/rules/database.mdx +1 -1
- package/templates/docs/04-internal/screens/common.mdx +15 -0
- package/templates/docs/04-internal/screens/dashboard.mdx +2 -2
- package/templates/docs/04-internal/screens/index.mdx +1 -1
- package/templates/docs/04-internal/screens/login.mdx +2 -2
- package/templates/docs/04-internal/screens/menu.mdx +2 -2
- package/templates/docs/index.tsx +61 -0
- package/templates/docs/introduction/document-editing/how-to.mdx +2 -2
- package/templates/docs/introduction/index.mdx +1 -1
- package/templates/docs/introduction/operational-policies/sharepoint.mdx +1 -1
- package/templates/package.json.template +12 -10
- package/templates/docs/02-requirements/functional/_category_.json +0 -8
- package/templates/docs/02-requirements/non-functional/_category_.json +0 -8
- /package/templates/docs/introduction/document-editing/{_category_.yml → _category_.yaml} +0 -0
package/README.md
CHANGED
|
@@ -368,7 +368,7 @@ We welcome contributions to the project! See [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
|
368
368
|
1. 💡 **Feature Requests**: [GitHub Discussions](https://github.com/plenarc/create-specment/discussions)
|
|
369
369
|
1. 📖 **Documentation**: [Official Documentation](https://create-specment.dev)
|
|
370
370
|
|
|
371
|
-
##
|
|
371
|
+
## Related projects
|
|
372
372
|
|
|
373
373
|
1. [Docusaurus](https://docusaurus.io/) - Static site generator
|
|
374
374
|
1. [mise](https://mise.jdx.dev/) - Development environment management tool
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-specment",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Interactive CLI tool for creating Docusaurus-based specification documentation projects",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "Plenarc",
|
|
@@ -41,13 +41,13 @@
|
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@clack/prompts": "^0.11.0",
|
|
43
43
|
"chalk": "^5.6.2",
|
|
44
|
-
"commander": "^14.0.
|
|
44
|
+
"commander": "^14.0.3"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@biomejs/biome": "^2.
|
|
48
|
-
"@types/node": "^25.
|
|
49
|
-
"typescript": "
|
|
50
|
-
"vitest": "^4.
|
|
47
|
+
"@biomejs/biome": "^2.4.16",
|
|
48
|
+
"@types/node": "^25.5.2",
|
|
49
|
+
"typescript": "~6.0.3",
|
|
50
|
+
"vitest": "^4.1.8"
|
|
51
51
|
},
|
|
52
52
|
"engines": {
|
|
53
53
|
"node": ">=22.0.0"
|
|
@@ -7,11 +7,11 @@ import { TBD } from '@site/src/components/TBD';
|
|
|
7
7
|
|
|
8
8
|
# Glossary - 用語集
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
{/*
|
|
11
11
|
TBDの使い方
|
|
12
12
|
<TBD/> コンポーネントは未確定項目を可視化するための占位マークです
|
|
13
13
|
執筆完了後はimport文といっしょにこのコメントも必ず削除すること
|
|
14
|
-
|
|
14
|
+
*/}
|
|
15
15
|
|
|
16
16
|
## 使い方ガイド {#how-to-use}
|
|
17
17
|
1. 用語は **アルファベット順 → かな順 → その他** の順番で並べる
|
|
@@ -39,7 +39,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
39
39
|
## SWOT分析結果
|
|
40
40
|
|
|
41
41
|
### Strengths (強み)
|
|
42
|
-
|
|
42
|
+
{/* 内部環境のプラス要因 */}
|
|
43
43
|
|
|
44
44
|
1. **技術力**
|
|
45
45
|
1. 高度な技術スキルを持つエンジニアチーム
|
|
@@ -55,7 +55,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
55
55
|
1. 豊富なドメイン知識
|
|
56
56
|
|
|
57
57
|
### Weaknesses (弱み)
|
|
58
|
-
|
|
58
|
+
{/* 内部環境のマイナス要因 */}
|
|
59
59
|
|
|
60
60
|
1. **技術面**
|
|
61
61
|
1. 特定技術領域での経験不足
|
|
@@ -71,7 +71,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
71
71
|
1. 変更管理の仕組み不足
|
|
72
72
|
|
|
73
73
|
### Opportunities (機会)
|
|
74
|
-
|
|
74
|
+
{/* 外部環境のプラス要因 */}
|
|
75
75
|
|
|
76
76
|
1. **市場環境**
|
|
77
77
|
1. デジタル化需要の拡大
|
|
@@ -87,7 +87,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
87
87
|
1. 業界ガイドラインの整備
|
|
88
88
|
|
|
89
89
|
### Threats (脅威)
|
|
90
|
-
|
|
90
|
+
{/* 外部環境のマイナス要因 */}
|
|
91
91
|
|
|
92
92
|
1. **競合環境**
|
|
93
93
|
1. 競合他社の技術力向上
|
|
@@ -105,7 +105,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
105
105
|
## 戦略マトリックス
|
|
106
106
|
|
|
107
107
|
### SO戦略 (強み × 機会)
|
|
108
|
-
|
|
108
|
+
{/* 強みを活かして機会を捉える戦略 */}
|
|
109
109
|
|
|
110
110
|
1. **技術力を活かした新サービス展開**
|
|
111
111
|
1. 高度な技術力を活用してデジタル化需要に対応
|
|
@@ -115,7 +115,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
115
115
|
1. パートナー企業との連携強化
|
|
116
116
|
|
|
117
117
|
### WO戦略 (弱み × 機会)
|
|
118
|
-
|
|
118
|
+
{/* 弱みを改善して機会を捉える戦略 */}
|
|
119
119
|
|
|
120
120
|
1. **スキル強化による競争力向上**
|
|
121
121
|
1. 新技術研修の実施
|
|
@@ -125,7 +125,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
125
125
|
1. ドキュメント化の推進
|
|
126
126
|
|
|
127
127
|
### ST戦略 (強み × 脅威)
|
|
128
|
-
|
|
128
|
+
{/* 強みを活かして脅威を回避する戦略 */}
|
|
129
129
|
|
|
130
130
|
1. **技術力による差別化**
|
|
131
131
|
1. 競合他社との技術的差別化
|
|
@@ -135,7 +135,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
135
135
|
1. 顧客との長期的関係構築
|
|
136
136
|
|
|
137
137
|
### WT戦略 (弱み × 脅威)
|
|
138
|
-
|
|
138
|
+
{/* 弱みと脅威を最小化する戦略 */}
|
|
139
139
|
|
|
140
140
|
1. **リスク軽減策の実施**
|
|
141
141
|
1. 技術リスクの早期発見・対応
|
|
@@ -147,7 +147,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
147
147
|
## アクションプラン
|
|
148
148
|
|
|
149
149
|
### 短期施策 (3ヶ月以内)
|
|
150
|
-
|
|
150
|
+
{/* 短期的に実施すべき施策 */}
|
|
151
151
|
|
|
152
152
|
1. **技術スキル強化**
|
|
153
153
|
1. 新技術研修の計画・実施
|
|
@@ -157,7 +157,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
157
157
|
1. ドキュメントテンプレートの整備
|
|
158
158
|
|
|
159
159
|
### 中期施策 (6ヶ月以内)
|
|
160
|
-
|
|
160
|
+
{/* 中期的に実施すべき施策 */}
|
|
161
161
|
|
|
162
162
|
1. **組織体制強化**
|
|
163
163
|
1. 専門チームの設立
|
|
@@ -167,7 +167,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
167
167
|
1. 新規パートナーの開拓
|
|
168
168
|
|
|
169
169
|
### 長期施策 (1年以内)
|
|
170
|
-
|
|
170
|
+
{/* 長期的に実施すべき施策 */}
|
|
171
171
|
|
|
172
172
|
1. **戦略的投資**
|
|
173
173
|
1. 新技術への投資
|
|
@@ -179,7 +179,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
179
179
|
## 評価・見直し
|
|
180
180
|
|
|
181
181
|
### 評価指標
|
|
182
|
-
|
|
182
|
+
{/* SWOT分析結果の評価指標 */}
|
|
183
183
|
|
|
184
184
|
1. **技術力指標**
|
|
185
185
|
1. 新技術習得率
|
|
@@ -192,7 +192,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
|
|
|
192
192
|
1. 顧客満足度
|
|
193
193
|
|
|
194
194
|
### 見直しサイクル
|
|
195
|
-
|
|
195
|
+
{/* SWOT分析の見直し頻度とタイミング */}
|
|
196
196
|
|
|
197
197
|
1. **四半期レビュー**: 戦略の進捗確認
|
|
198
198
|
1. **半期レビュー**: SWOT要素の再評価
|
|
@@ -7,11 +7,11 @@ import { TBD } from '@site/src/components/TBD';
|
|
|
7
7
|
|
|
8
8
|
# To‑Be - 目指すべき姿
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
{/*
|
|
11
11
|
TBDの使い方
|
|
12
12
|
<TBD/> コンポーネントは未確定項目を可視化するための占位マークです
|
|
13
13
|
執筆完了後はimport文といっしょにこのコメントも必ず削除すること
|
|
14
|
-
|
|
14
|
+
*/}
|
|
15
15
|
|
|
16
16
|
## 概要 {#target-overview}
|
|
17
17
|
1. 本章で示す「理想状態」と As‑Is との差分を概観する
|
|
@@ -10,32 +10,32 @@ draft: true
|
|
|
10
10
|
---
|
|
11
11
|
import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
{/* <div style={{ marginBottom: "1rem" }}>
|
|
14
14
|
{frontMatter.tags.map((tag) => (
|
|
15
15
|
<Tag key={tag} name={tag} />
|
|
16
16
|
))}
|
|
17
|
-
</div>
|
|
17
|
+
</div> */}
|
|
18
18
|
|
|
19
19
|
## 概要
|
|
20
|
-
|
|
20
|
+
{/* 1-2文で要求の概要を記述 */}
|
|
21
21
|
|
|
22
22
|
## 詳細要件
|
|
23
|
-
|
|
23
|
+
{/* 箇条書きで具体的な要件を記述 */}
|
|
24
24
|
- 要件1
|
|
25
25
|
- 要件2
|
|
26
26
|
- 要件3
|
|
27
27
|
|
|
28
28
|
## 受け入れ基準
|
|
29
|
-
|
|
29
|
+
{/* この要求が満たされたと判断できる基準を記述 */}
|
|
30
30
|
- [ ] 基準1
|
|
31
31
|
- [ ] 基準2
|
|
32
32
|
|
|
33
33
|
## 関連する非機能要件
|
|
34
|
-
|
|
34
|
+
{/* 関連するNFRへのリンク */}
|
|
35
35
|
- [NFR-001:パフォーマンス要件](../non-functional/nfr-001.mdx)
|
|
36
36
|
|
|
37
37
|
## 参考情報
|
|
38
|
-
|
|
38
|
+
{/* 追加の情報、図表、リンクなど */}
|
|
39
39
|
|
|
40
40
|
export const changes = [
|
|
41
41
|
{
|
|
@@ -8,14 +8,15 @@ urgency: 7
|
|
|
8
8
|
importance: 8
|
|
9
9
|
---
|
|
10
10
|
import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
|
|
11
|
+
// import { ChangeHistoryComponent } from '@site/src/components/ChangeHistory';
|
|
11
12
|
|
|
12
13
|
<PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
|
|
13
14
|
|
|
14
|
-
|
|
15
|
+
{/* <div style={{ marginBottom: "1rem" }}>
|
|
15
16
|
{frontMatter.tags.map((tag) => (
|
|
16
17
|
<Tag key={tag} name={tag} />
|
|
17
18
|
))}
|
|
18
|
-
</div>
|
|
19
|
+
</div> */}
|
|
19
20
|
|
|
20
21
|
## 概要
|
|
21
22
|
システムへのアクセスを制御するためのユーザー認証機能を提供する。
|
|
@@ -13,23 +13,23 @@ import { ChangeHistoryComponent } from '@site/src/components/ChangeHistory';
|
|
|
13
13
|
<PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
|
|
14
14
|
|
|
15
15
|
## 概要
|
|
16
|
-
|
|
16
|
+
{/* 非機能要件の概要を記述 */}
|
|
17
17
|
|
|
18
18
|
## 詳細要件
|
|
19
19
|
### カテゴリ1
|
|
20
|
-
|
|
20
|
+
{/* 要件の詳細を記述 */}
|
|
21
21
|
|
|
22
22
|
### カテゴリ2
|
|
23
|
-
|
|
23
|
+
{/* 要件の詳細を記述 */}
|
|
24
24
|
|
|
25
25
|
## 測定方法
|
|
26
|
-
|
|
26
|
+
{/* 要件の達成を測定する方法を記述 */}
|
|
27
27
|
|
|
28
28
|
## 制約条件
|
|
29
|
-
|
|
29
|
+
{/* 制約条件があれば記述 */}
|
|
30
30
|
|
|
31
31
|
## 関連する機能要件
|
|
32
|
-
|
|
32
|
+
{/* 関連する機能要件へのリンク */}
|
|
33
33
|
|
|
34
34
|
export const changes = [
|
|
35
35
|
{
|
|
@@ -11,4 +11,4 @@ import BusinessModel from '@site/static/img/business-model.drawio.svg';
|
|
|
11
11
|
1. 参考
|
|
12
12
|
1. https://drawio-app.com/blog/business-model-canvas/
|
|
13
13
|
1. note: 『ビジネスの仕組みがわかる 図解のつくりかた』全文公開
|
|
14
|
-
1. https://note.com/bizgram/n/n3dbed12f95ea
|
|
14
|
+
1. https://note.com/bizgram/n/n3dbed12f95ea
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 4
|
|
3
|
+
tags:
|
|
4
|
+
- claude
|
|
5
|
+
- ai
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Claudeの使い方
|
|
9
|
+
|
|
10
|
+
このプロジェクトでは[Claude Code](https://claude.ai/code)を使ってドキュメント作成を効率化しています。
|
|
11
|
+
|
|
12
|
+
## スラッシュコマンド
|
|
13
|
+
|
|
14
|
+
ドキュメントの新規作成はスラッシュコマンドで行います。
|
|
15
|
+
ファイル作成と `index.mdx` への登録を自動で行います。
|
|
16
|
+
|
|
17
|
+
### /new-table
|
|
18
|
+
|
|
19
|
+
テーブル定義ドキュメントを新規作成します。
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
/new-table <physical_name> <logical_name> <schema> <description>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
1. 作成先: `docs/04-internal/tables/{physical_name}.mdx`
|
|
26
|
+
1. index登録: `docs/04-internal/tables/index.mdx`
|
|
27
|
+
|
|
28
|
+
例
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
/new-table orders 注文 public 注文情報を管理するテーブル
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### /new-screen
|
|
35
|
+
|
|
36
|
+
画面定義ドキュメントを新規作成します。
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
/new-screen <physical_name> <logical_name>
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
1. 作成先: `docs/04-internal/screens/{physical_name}.mdx`
|
|
43
|
+
1. index登録: `docs/04-internal/screens/index.mdx`
|
|
44
|
+
|
|
45
|
+
例
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
/new-screen order-list 注文一覧
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### /new-batch
|
|
52
|
+
|
|
53
|
+
バッチ定義ドキュメントを新規作成します。
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
/new-batch <id> <logical_name>
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
1. 作成先: `docs/04-internal/batches/{id}.mdx`
|
|
60
|
+
1. index登録: `docs/04-internal/batches/index.mdx`
|
|
61
|
+
|
|
62
|
+
例
|
|
63
|
+
|
|
64
|
+
```
|
|
65
|
+
/new-batch import-orders 注文取込
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Claudeが参照するルール
|
|
69
|
+
|
|
70
|
+
Claudeは `.claude/rules/` 配下のファイルを参照してドキュメントを作成します。
|
|
71
|
+
各ルールの詳細は以下のドキュメントが権威ある情報源です。
|
|
72
|
+
|
|
73
|
+
| ルールファイル | 参照先 |
|
|
74
|
+
| -------------- | ------ |
|
|
75
|
+
| `.claude/rules/markdown.md` | [Markdown](../rules/markdown.mdx) ※ルートのrulesを参照 |
|
|
76
|
+
| `.claude/rules/git.md` | [ブランチ命名規約](./branch-naming-rules.mdx)、[PR運用フロー](./pull-request-operation-flow.mdx) |
|
|
77
|
+
| `.claude/rules/database.md` | [データベース](../rules/database.mdx) |
|
|
78
|
+
| `.claude/rules/document-creation.md` | [ドキュメント作成ルール](../rules/document-creation-rules.mdx) |
|
|
79
|
+
| `.claude/rules/review.md` | [レビュープロセス](../rules/review-process.mdx) |
|
|
80
|
+
|
|
81
|
+
## Claudeの操作範囲
|
|
82
|
+
|
|
83
|
+
Claudeが自律的に行ってよい操作と禁止操作を明確にしています。
|
|
84
|
+
|
|
85
|
+
| 操作 | 可否 |
|
|
86
|
+
| ---- | :--: |
|
|
87
|
+
| ファイルの作成・編集・削除 | :o: |
|
|
88
|
+
| `git add`(ステージング) | :o: |
|
|
89
|
+
| `git fetch`、`git checkout` | :o: |
|
|
90
|
+
| `git commit` | :x: |
|
|
91
|
+
| `git push` | :x: |
|
|
@@ -4,23 +4,21 @@ tags:
|
|
|
4
4
|
- git
|
|
5
5
|
- github
|
|
6
6
|
---
|
|
7
|
-
import TBD from '@site/src/components/TBD';
|
|
7
|
+
import { TBD } from '@site/src/components/TBD';
|
|
8
8
|
|
|
9
9
|
# GitHubの利用方法
|
|
10
10
|
|
|
11
11
|
## 基本的なGitHubの利用ルール
|
|
12
12
|
|
|
13
13
|
### コミットメッセージのルール
|
|
14
|
-
1.
|
|
15
|
-
1.
|
|
16
|
-
1.
|
|
14
|
+
1. 日本語で記述する
|
|
15
|
+
1. 英語プレフィックス(`feat:`、`fix:`、`chore:` など)は使用しない
|
|
16
|
+
1. 日本語の動詞で始める(「追加」「修正」「更新」「削除」「変更」)
|
|
17
17
|
1. 50文字以内に収める
|
|
18
18
|
|
|
19
19
|
### ブランチ戦略
|
|
20
|
-
1.
|
|
21
|
-
1.
|
|
22
|
-
1. バグ修正は`fix/バグ内容`ブランチで行う
|
|
23
|
-
1. リリース準備は`release/バージョン番号`ブランチで行う
|
|
20
|
+
1. ブランチ命名規則の詳細は[ブランチ命名規約](./branch-naming-rules.mdx)を参照
|
|
21
|
+
1. `main` ブランチは常に安定した状態を保つ
|
|
24
22
|
|
|
25
23
|
### プルリクエスト(PR)のルール
|
|
26
24
|
1. 明確なタイトルと説明を書く
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
sidebar_position: 4
|
|
3
3
|
---
|
|
4
|
-
import TBD from '@site/src/components/TBD';
|
|
4
|
+
import { TBD } from '@site/src/components/TBD';
|
|
5
5
|
|
|
6
6
|
# ダッシュボード
|
|
7
7
|
## ファイル
|
|
8
|
-
|
|
8
|
+
{/* 1. frontend/src/routes/[dashboard.svelte](../../../../frontend/src/routes/dashboard.svelte) */}
|
|
9
9
|
|
|
10
10
|
## 概要
|
|
11
11
|
1. <TBD/>
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
sidebar_position: 2
|
|
3
3
|
---
|
|
4
|
-
import TBD from '@site/src/components/TBD';
|
|
4
|
+
import { TBD } from '@site/src/components/TBD';
|
|
5
5
|
|
|
6
6
|
# ログイン
|
|
7
7
|
## ファイル
|
|
8
|
-
|
|
8
|
+
{/* 1. frontend/src/routes/[login.svelte](../../../../frontend/src/routes/login.svelte) */}
|
|
9
9
|
|
|
10
10
|
## 概要
|
|
11
11
|
1. ログイン画面
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
---
|
|
2
2
|
sidebar_position: 3
|
|
3
3
|
---
|
|
4
|
-
import TBD from '@site/src/components/TBD';
|
|
4
|
+
import { TBD } from '@site/src/components/TBD';
|
|
5
5
|
|
|
6
6
|
# メニュー
|
|
7
7
|
## ファイル
|
|
8
|
-
|
|
8
|
+
{/* 1. frontend/src/routes/[menu.svelte](../../../../frontend/src/routes/menu.svelte) */}
|
|
9
9
|
|
|
10
10
|
## 概要
|
|
11
11
|
1. メニュー画面
|
package/templates/docs/index.tsx
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import Link from '@docusaurus/Link';
|
|
1
2
|
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
|
2
3
|
import Heading from '@theme/Heading';
|
|
3
4
|
import Layout from '@theme/Layout';
|
|
@@ -29,7 +30,67 @@ function DocumentSection() {
|
|
|
29
30
|
<p>
|
|
30
31
|
このサイトは{siteConfig.title}
|
|
31
32
|
の設計、仕様を管理するためのドキュメントサイトです。
|
|
33
|
+
<br />
|
|
34
|
+
システムの要件定義から詳細設計まで、プロジェクトに関する技術文書を体系的に管理しています。
|
|
32
35
|
</p>
|
|
36
|
+
|
|
37
|
+
<div className="row">
|
|
38
|
+
<div className="col col--4">
|
|
39
|
+
<div className={styles.featureCard}>
|
|
40
|
+
<Heading as="h3">ドキュメント構成</Heading>
|
|
41
|
+
<ul>
|
|
42
|
+
<li>
|
|
43
|
+
<Link to="/docs/overview">プロジェクト概要・分析</Link>
|
|
44
|
+
</li>
|
|
45
|
+
<li>
|
|
46
|
+
<Link to="/docs/requirements">要件定義</Link>
|
|
47
|
+
</li>
|
|
48
|
+
<li>
|
|
49
|
+
<Link to="/docs/external">外部設計</Link>
|
|
50
|
+
</li>
|
|
51
|
+
<li>
|
|
52
|
+
<Link to="/docs/internal">内部設計</Link>
|
|
53
|
+
</li>
|
|
54
|
+
</ul>
|
|
55
|
+
</div>
|
|
56
|
+
</div>
|
|
57
|
+
<div className="col col--4">
|
|
58
|
+
<div className={styles.featureCard}>
|
|
59
|
+
<Heading as="h3">編集ガイド</Heading>
|
|
60
|
+
<ul>
|
|
61
|
+
<li>
|
|
62
|
+
<Link to="/docs/internal/rules/markdown">Markdownの書き方</Link>
|
|
63
|
+
</li>
|
|
64
|
+
<li>
|
|
65
|
+
<Link to="/docs/internal/rules/document-creation-rules">
|
|
66
|
+
ドキュメント作成ルール
|
|
67
|
+
</Link>
|
|
68
|
+
</li>
|
|
69
|
+
<li>
|
|
70
|
+
<Link to="/docs/internal/rules/review-process">レビュープロセス</Link>
|
|
71
|
+
</li>
|
|
72
|
+
</ul>
|
|
73
|
+
</div>
|
|
74
|
+
</div>
|
|
75
|
+
<div className="col col--4">
|
|
76
|
+
<div className={styles.featureCard}>
|
|
77
|
+
<Heading as="h3">運用ポリシー</Heading>
|
|
78
|
+
<ul>
|
|
79
|
+
<li>
|
|
80
|
+
<Link to="/docs/internal/policies/github">GitHubの利用方法</Link>
|
|
81
|
+
</li>
|
|
82
|
+
<li>
|
|
83
|
+
<Link to="/docs/internal/policies/pull-request-operation-flow">
|
|
84
|
+
pull request運用フロー
|
|
85
|
+
</Link>
|
|
86
|
+
</li>
|
|
87
|
+
<li>
|
|
88
|
+
<Link to="/docs/internal/policies/branch-naming-rules">branch命名規約</Link>
|
|
89
|
+
</li>
|
|
90
|
+
</ul>
|
|
91
|
+
</div>
|
|
92
|
+
</div>
|
|
93
|
+
</div>
|
|
33
94
|
</div>
|
|
34
95
|
</div>
|
|
35
96
|
);
|
|
@@ -23,9 +23,9 @@ tag:
|
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
## 階層表示したい場合 {#to-layerd}
|
|
26
|
-
1. サブフォルダーを作成し、そこにファイル `_category_.
|
|
26
|
+
1. サブフォルダーを作成し、そこにファイル `_category_.yaml` を作る
|
|
27
27
|
1. 例
|
|
28
|
-
```yml title="_category_.
|
|
28
|
+
```yml title="_category_.yaml"
|
|
29
29
|
label: 'ドキュメント編集方法'
|
|
30
30
|
position: 4
|
|
31
31
|
```
|
|
@@ -15,26 +15,28 @@
|
|
|
15
15
|
"typecheck": "tsc"
|
|
16
16
|
},
|
|
17
17
|
"dependencies": {
|
|
18
|
-
"@docusaurus/core": "
|
|
19
|
-
"@docusaurus/preset-classic": "
|
|
20
|
-
"@docusaurus/theme-mermaid": "
|
|
21
|
-
"@easyops-cn/docusaurus-search-local": "^0.
|
|
18
|
+
"@docusaurus/core": "3.10.1",
|
|
19
|
+
"@docusaurus/preset-classic": "3.10.1"{{#hasMermaid}},
|
|
20
|
+
"@docusaurus/theme-mermaid": "3.10.1"{{/hasMermaid}},
|
|
21
|
+
"@easyops-cn/docusaurus-search-local": "^0.55.1",
|
|
22
22
|
"@mdx-js/react": "^3.0.0",
|
|
23
23
|
"clsx": "^2.0.0"{{#hasPlantUML}},
|
|
24
|
-
"docusaurus-theme-plantuml": "^1.
|
|
24
|
+
"docusaurus-theme-plantuml": "^1.3.2"{{/hasPlantUML}},
|
|
25
|
+
"js-yaml": "^4.1.1",
|
|
25
26
|
"prism-react-renderer": "^2.4.1",
|
|
26
27
|
"react": "^19.0.0",
|
|
27
28
|
"react-dom": "^19.0.0"{{#hasRedoc}},
|
|
28
29
|
"redocusaurus": "^2.5.0"{{/hasRedoc}}
|
|
29
30
|
},
|
|
30
31
|
"devDependencies": {
|
|
31
|
-
"@
|
|
32
|
-
"@docusaurus/
|
|
33
|
-
"@docusaurus/
|
|
34
|
-
"@types
|
|
32
|
+
"@biomejs/biome": "^2.4.15",
|
|
33
|
+
"@docusaurus/module-type-aliases": "3.10.1",
|
|
34
|
+
"@docusaurus/tsconfig": "3.10.1",
|
|
35
|
+
"@docusaurus/types": "3.10.1",
|
|
36
|
+
"@types/node": "^22.0.0",
|
|
35
37
|
"@types/react": "^19.0.0",
|
|
36
38
|
"@types/react-dom": "^19.0.0",
|
|
37
|
-
"typescript": "~
|
|
39
|
+
"typescript": "~6.0.3"
|
|
38
40
|
},
|
|
39
41
|
"browserslist": {
|
|
40
42
|
"production": [">0.5%", "not dead", "not op_mini all"],
|
|
File without changes
|