create-specment 0.2.3 → 0.2.9

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.
Files changed (122) hide show
  1. package/bin/commands/create.d.ts.map +1 -1
  2. package/bin/commands/create.js.map +1 -1
  3. package/bin/constants/languages.d.ts +1 -1
  4. package/bin/constants/languages.d.ts.map +1 -1
  5. package/bin/constants/languages.js +3 -3
  6. package/bin/core/interactive-setup.d.ts.map +1 -1
  7. package/bin/core/interactive-setup.js +20 -18
  8. package/bin/core/interactive-setup.js.map +1 -1
  9. package/bin/core/interactive-setup.test.js +11 -11
  10. package/bin/core/interactive-setup.test.js.map +1 -1
  11. package/bin/core/project-generator.d.ts.map +1 -1
  12. package/bin/core/project-generator.js +5 -10
  13. package/bin/core/project-generator.js.map +1 -1
  14. package/bin/features/index.js +12 -12
  15. package/bin/generators/docusaurus-config.js +48 -48
  16. package/bin/generators/docusaurus-config.js.map +1 -1
  17. package/bin/generators/package-json.js +14 -14
  18. package/bin/generators/package-json.js.map +1 -1
  19. package/bin/generators/template-files.d.ts.map +1 -1
  20. package/bin/generators/template-files.js +117 -121
  21. package/bin/generators/template-files.js.map +1 -1
  22. package/bin/index.d.ts.map +1 -1
  23. package/bin/index.js.map +1 -1
  24. package/bin/plugins/i18n-integration.d.ts.map +1 -1
  25. package/bin/plugins/i18n-integration.js +61 -60
  26. package/bin/plugins/i18n-integration.js.map +1 -1
  27. package/bin/plugins/plantuml-integration.d.ts.map +1 -1
  28. package/bin/plugins/plantuml-integration.js +12 -11
  29. package/bin/plugins/plantuml-integration.js.map +1 -1
  30. package/bin/plugins/redoc-integration.d.ts.map +1 -1
  31. package/bin/plugins/redoc-integration.js +13 -12
  32. package/bin/plugins/redoc-integration.js.map +1 -1
  33. package/bin/plugins/search-integration.d.ts.map +1 -1
  34. package/bin/plugins/search-integration.js +15 -11
  35. package/bin/plugins/search-integration.js.map +1 -1
  36. package/bin/templates/index.js +15 -15
  37. package/bin/templates/index.js.map +1 -1
  38. package/bin/templates/template-definitions.d.ts.map +1 -1
  39. package/bin/templates/template-definitions.js +223 -2
  40. package/bin/templates/template-definitions.js.map +1 -1
  41. package/bin/tests/integration.test.js +26 -24
  42. package/bin/tests/integration.test.js.map +1 -1
  43. package/bin/utils/config-merger.d.ts +1 -1
  44. package/bin/utils/config-merger.d.ts.map +1 -1
  45. package/bin/utils/config-merger.js +12 -14
  46. package/bin/utils/config-merger.js.map +1 -1
  47. package/bin/utils/install.d.ts.map +1 -1
  48. package/bin/utils/install.js +28 -4
  49. package/bin/utils/install.js.map +1 -1
  50. package/bin/utils/message-formatter.d.ts.map +1 -1
  51. package/bin/utils/message-formatter.js +1 -0
  52. package/bin/utils/message-formatter.js.map +1 -1
  53. package/bin/utils/template-processor.d.ts.map +1 -1
  54. package/bin/utils/template-processor.js +2 -2
  55. package/bin/utils/template-processor.js.map +1 -1
  56. package/bin/utils/version.js +3 -3
  57. package/bin/utils/version.js.map +1 -1
  58. package/package.json +2 -3
  59. package/templates/docs/01-overview/_assumptions-constraints.mdx +19 -0
  60. package/templates/docs/01-overview/_business-context.mdx +18 -0
  61. package/templates/docs/01-overview/_firm-proposal.mdx +52 -0
  62. package/templates/docs/01-overview/_gap-analysis.mdx +18 -0
  63. package/templates/docs/01-overview/_project/342/200/221charter.mdx +23 -0
  64. package/templates/docs/01-overview/_requirements-specification.mdx +77 -0
  65. package/templates/docs/01-overview/_risks.mdx +16 -0
  66. package/templates/docs/01-overview/_scope.mdx +24 -0
  67. package/templates/docs/01-overview/_stakeholders.mdx +24 -0
  68. package/templates/docs/01-overview/as-is.mdx +64 -0
  69. package/templates/docs/01-overview/glossary.mdx +41 -0
  70. package/templates/docs/01-overview/index.mdx +41 -0
  71. package/templates/docs/01-overview/odsc.mdx +72 -0
  72. package/templates/docs/01-overview/roadmap.mdx +27 -0
  73. package/templates/docs/01-overview/system-context.mdx +22 -0
  74. package/templates/docs/01-overview/to-be.mdx +102 -0
  75. package/templates/docs/02-requirements/_category_.yaml +2 -0
  76. package/templates/docs/02-requirements/functional/_category_.json +8 -0
  77. package/templates/docs/02-requirements/functional/_req-template.mdx +49 -0
  78. package/templates/docs/02-requirements/functional/req-001.mdx +56 -0
  79. package/templates/docs/02-requirements/index.mdx +14 -0
  80. package/templates/docs/02-requirements/non-functional/_category_.json +8 -0
  81. package/templates/docs/02-requirements/non-functional/_nfr-template.mdx +45 -0
  82. package/templates/docs/02-requirements/non-functional/nfr-001.mdx +60 -0
  83. package/templates/docs/02-requirements/non-functional/nfr-002.mdx +60 -0
  84. package/templates/docs/03-external/business-model.mdx +14 -0
  85. package/templates/docs/03-external/img/business-model-by-claude.xml +107 -0
  86. package/templates/docs/03-external/img/business-model.xml +84 -0
  87. package/templates/docs/03-external/img/docsVersionDropdown.png +0 -0
  88. package/templates/docs/03-external/img/gantt.xml +1 -0
  89. package/templates/docs/03-external/img/localeDropdown.png +0 -0
  90. package/templates/docs/03-external/index.mdx +46 -0
  91. package/templates/docs/04-internal/batches/_category_.yaml +2 -0
  92. package/templates/docs/04-internal/batches/import-products.mdx +68 -0
  93. package/templates/docs/04-internal/batches/index.mdx +25 -0
  94. package/templates/docs/04-internal/index.mdx +32 -0
  95. package/templates/docs/04-internal/policies/_category_.yaml +2 -0
  96. package/templates/docs/04-internal/policies/branch-naming-rules.mdx +110 -0
  97. package/templates/docs/04-internal/policies/github.mdx +100 -0
  98. package/templates/docs/04-internal/policies/pull-request-operation-flow.mdx +118 -0
  99. package/templates/docs/04-internal/rules/_category_.yaml +2 -0
  100. package/templates/docs/04-internal/rules/database.mdx +139 -0
  101. package/templates/docs/04-internal/rules/document-creation-rules.mdx +39 -0
  102. package/templates/docs/04-internal/rules/index.mdx +10 -0
  103. package/templates/docs/04-internal/rules/markdown.mdx +148 -0
  104. package/templates/docs/04-internal/rules/review-process.mdx +32 -0
  105. package/templates/docs/04-internal/screens/_category_.yaml +2 -0
  106. package/templates/docs/04-internal/screens/dashboard.mdx +17 -0
  107. package/templates/docs/04-internal/screens/index.mdx +20 -0
  108. package/templates/docs/04-internal/screens/login.mdx +18 -0
  109. package/templates/docs/04-internal/screens/menu.mdx +17 -0
  110. package/templates/docs/04-internal/tables/_category_.yaml +2 -0
  111. package/templates/docs/04-internal/tables/customer_details.mdx +35 -0
  112. package/templates/docs/04-internal/tables/customers.mdx +35 -0
  113. package/templates/docs/04-internal/tables/index.mdx +11 -0
  114. package/templates/docs/example.drawio.svg +57 -0
  115. package/templates/docs/intro.md +47 -0
  116. package/templates/docs/introduction/document-editing/_category_.yml +2 -0
  117. package/templates/docs/introduction/document-editing/how-to.mdx +31 -0
  118. package/templates/docs/introduction/index.mdx +35 -0
  119. package/templates/docs/introduction/operational-policies/_category_.yaml +2 -0
  120. package/templates/docs/introduction/operational-policies/github.mdx +33 -0
  121. package/templates/docs/introduction/operational-policies/img/branch-naming-rules.svg +73 -0
  122. package/templates/docs/introduction/operational-policies/sharepoint.mdx +28 -0
@@ -0,0 +1,39 @@
1
+ ---
2
+ sidebar_position: 3
3
+ ---
4
+ # ドキュメント作成ルール
5
+
6
+ ## ファイル命名規則
7
+ 1. ファイル名はケバブケースを利用。日本語禁止
8
+ 1. 例
9
+ `document-creation-rules.mdx`
10
+ 1. テンプレートファイル(ファイル名が`_`で始まるもの)がある場合は、該当ファイルをコピーして使用する
11
+
12
+ ## Frontmatter(header yaml)の書き方
13
+ 1. 各MDXファイルの先頭には必ずYAMLフロントマターを記述
14
+ 1. 必須フィールド
15
+ 1. `slug`:URLパス
16
+ 1. `title`:ページ見出し
17
+ 1. `sidebar_position`:サイドバー表示順
18
+ 1. 記述例
19
+ ```md
20
+ ---
21
+ sidebar_position: 1
22
+ ---
23
+ ```
24
+
25
+ ## 執筆スタイル
26
+ 1. 1ファイル内の文体は「です/ます調」を統一すること
27
+ 1. 専門用語や略語を初出時に日本語で説明する
28
+
29
+ ## `_category_.yaml` の書き方
30
+ 1. フォルダーをsidebarで日本語表示するために必要
31
+ 1. 各ドキュメントフォルダー直下に配置
32
+ 1. 必須フィールド
33
+ 1. `label`:カテゴリ名
34
+ 1. `position`:サイドバー内の並び順(数値)
35
+ 1. 記述例
36
+ ```yaml
37
+ label: ドキュメント作成
38
+ position: 1
39
+ ```
@@ -0,0 +1,10 @@
1
+ ---
2
+ sidebar_position: 1
3
+ ---
4
+ # 規約・ルール
5
+ 1. [markdown](markdown.mdx)
6
+ 1. [databaase](database.mdx)
7
+ 1. TypeScript
8
+ 1. Google TypeScript Style Guide
9
+ 1. https://google.github.io/styleguide/tsguide.html
10
+
@@ -0,0 +1,148 @@
1
+ ---
2
+ sidebar_position: 2
3
+ tags:
4
+ - Markdown
5
+ ---
6
+ # Markdown
7
+ ## 基本 {#basic}
8
+ ### 章立て {#chapter}
9
+ 1. 例
10
+ ```markdown
11
+ # 章タイトル
12
+ ## 章タイトルごとに"#"を増やす。最大で5章まで
13
+ 1. 実用的には3、4階層が妥当
14
+ 1. 深すぎる階層が多くなる場合は抽象度を再検討する
15
+ ```
16
+ 1. 章のひとつ上の行は空行にする
17
+ 1. ただし、更に上の行が章の場合は空行不要
18
+ 1. 例
19
+ ```markdown
20
+ # 本タイトル
21
+ ## サブタイトル1。本タイトルとサブタイトルの間に空行は不要
22
+ 1. 箇条書き例
23
+
24
+ ## サブタイトル2。上の行は章ではないため、空行を入れる
25
+ 1. 箇条書き例
26
+ ```
27
+
28
+ ### 箇条書き {#itemization}
29
+ 1. 仕様を会話で伝える際、番号であったほうが伝えやすいので数値になるように `1. ` を使用する
30
+ 1. 数値はレンダリング時に連番になるので、2番目以降でもすべて `1. ` とする
31
+ 1. 例
32
+ ```markdown
33
+ 1. 1つ目
34
+ 1. 2つ目でも "1. "
35
+ 1. インデントは半角スペース4つ。タブ文字禁止
36
+ 1. 2つ目でも "1. "
37
+ ```
38
+ 1. 例のレンダリング結果
39
+ 1. 1つ目
40
+ 1. 2つ目でも "1. "
41
+ 1. インデントは半角スペース4つ。タブ文字禁止
42
+ 1. 2つ目でも "1. "
43
+ 1. VSCode利用時にインクリメントされてしまう場合は以下の設定にする
44
+ ```json title="settings.json"
45
+ "markdown.extension.orderedList.marker": "one",
46
+ ```
47
+
48
+ ### 強調表示 {#highlighting}
49
+ 1. 以下を参考
50
+ 1. 公式Docusaurus - Markdown Features: https://docusaurus.io/docs/markdown-features
51
+
52
+ :::note
53
+ 1. 斜体(italic)も使えるけど、あまり見やすいと思えないので、仕様としては使わないようにしたい
54
+ :::
55
+
56
+ ### その他 {#other}
57
+ 1. 使えるemoji。絵文字
58
+ 1. 参考: WebFX - [EMOJI CHEAT SHEET](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)
59
+
60
+ ## 応用 {#application}
61
+ ### 他ドキュメントへのリンク {#link-to-other-documents}
62
+ 1. 別のドキュメントファイルへのリンクは相対パスで書く
63
+
64
+ ```markdown
65
+ 1. 同じ階層なら > [別のmdx](other.mdx)
66
+ 1. 子階層 > [カレントにあるフォルダー内のファイル](subfolder/dummy.mdx)
67
+ 1. 別階層 > [親をたどって書く](../rules/markdown.mdx)
68
+ ```
69
+
70
+ ### 詳細表示 {#details}
71
+ 1. htmlの記述と同じ
72
+ 1. 例
73
+ ```mdx-code-block
74
+ <details>
75
+ <summary>ここをクリックして開閉</summary>
76
+ <div>
77
+ <div>詳細はここに書く</div>
78
+ \
79
+ <details>
80
+ <summary>ネストして書くこともできる</summary>
81
+ <div>
82
+ :grinning::smile::grin::laughing::blush::wink:
83
+ </div>
84
+ </details>
85
+ </div>
86
+ </details>
87
+ ```
88
+ 1. 例のレンダリング結果
89
+ <details>
90
+ <summary>ここをクリックして開閉</summary>
91
+ <div>
92
+ <div>詳細はここに書く</div>
93
+ \
94
+ <details>
95
+ <summary>ネストして書くこともできる</summary>
96
+ <div>
97
+ :grinning::smile::grin::laughing::blush::wink:
98
+ </div>
99
+ </details>
100
+ </div>
101
+ </details>
102
+
103
+ ### コードブロック {#code-block}
104
+ 1. \`\`\`(バッククォート3つ)で囲うとコードブロックになる
105
+ 1. 使えるコードは以下を参照
106
+ 1. prismjs.com - [Supported languages](https://prismjs.com/#supported-languages)
107
+ 1. `{`、`}` で囲うとその行がハイライト表示される
108
+ 1. `title=` を追加するとタイトル表示できる
109
+ 1. ハイライトとtitleを続けて書く場合は区切りとして半角スペースが必要
110
+ 1. 例
111
+ ```md
112
+ ```nim {4-6,8} title="sample.nim" showLineNumbers
113
+ import tables, strutils
114
+
115
+ var wordFrequencies = initCountTable[string]()
116
+ for line in stdin.lines:
117
+ for word in line.split(", "):
118
+ wordFrequencies.inc(word)
119
+
120
+ echo "The most frequent word is '", wordFrequencies.largest, "'"
121
+ ```
122
+
123
+ 1. 例のレンダリング結果
124
+ ```nim {4-6,8} title="sample.nim" showLineNumbers
125
+ import tables, strutils
126
+
127
+ var wordFrequencies = initCountTable[string]()
128
+ for line in stdin.lines:
129
+ for word in line.split(", "):
130
+ wordFrequencies.inc(word)
131
+
132
+ echo "The most frequent word is '", wordFrequencies.largest, "'"
133
+ ```
134
+
135
+ ## docusaurus用 {#for-docusaurus}
136
+ ### 強調記号 {#emphasis-added}
137
+ 1. アンダーバー(`_`)やアスタリスクなどを使う時、強調表示されてしまうので円マークorバックスラッシュ(`\`)を使って回避する
138
+ 1. `_Italic_` {'>'} _Italic_
139
+ 1. `\_Italic\_` {'>'} \_Italic\_
140
+
141
+ ### 不等号 {#inequality-sign}
142
+ 1. `<`、`>` を使うとhtmlタグ扱いでエラーとなる場合があるので以下の方法を使って回避する
143
+ 1. 全角不等号を使う
144
+ 1. :x:: `<強調したい文言>`
145
+ 1. :o:: `<強調したい文言>`
146
+ 1. `{'`、`'}` で括る
147
+ 1. :x:: `abc <= 100`
148
+ 1. :o:: `abc {'<='} 100`
@@ -0,0 +1,32 @@
1
+ ---
2
+ sidebar_position: 4
3
+ ---
4
+ # レビュープロセス
5
+
6
+ ## モブプログラミング推奨
7
+ 1. チーム全員でリアルタイムにコードを確認し、知識を共有する
8
+ 1. その場でフィードバックを行い、修正や改善を即時反映する
9
+
10
+ ## 設計との照合
11
+ 1. 実装が設計書どおりに実現されているか確認する
12
+ 1. 設計書の該当セクションとコード箇所を突き合わせる
13
+
14
+ ## 設計の妥当性確認
15
+ 1. 設計に漏れや誤りがないかレビューする
16
+ 1. 要件やユースケースの抜け漏れ、前提条件の過不足をチェックする
17
+
18
+ ## エラー/警告対応
19
+ 1. コンパイルエラーやリンター警告がすべて解消されているか確認する
20
+ 1. CIパイプラインでのビルド失敗やテストエラーがないかチェックする
21
+
22
+ ## コード品質
23
+ 1. 可読性・保守性の高いコードになっているか確認する
24
+ 1. 冗長なロジックや複雑度の高い箇所を適切にリファクタリングする
25
+
26
+ ## issueチェックリスト
27
+ 1. issueに紐づくチェックリスト項目(テスト、ドキュメント更新など)がすべて完了しているか確認する
28
+ 1. 必要に応じて新たなテストケースやドキュメントを追加する
29
+
30
+ ## 命名規則
31
+ 1. 変数名・関数名がプロジェクトの命名規則に沿っているか確認する
32
+ 1. 一貫性があり意図が明確な名前付けになっているかチェックする
@@ -0,0 +1,2 @@
1
+ label: '画面'
2
+ position: 5
@@ -0,0 +1,17 @@
1
+ ---
2
+ sidebar_position: 4
3
+ ---
4
+ import { TBD } from '@site/src/components/TBD';
5
+
6
+ # ダッシュボード
7
+ ## ファイル
8
+ <!-- 1. frontend/src/routes/[dashboard.svelte](../../../../frontend/src/routes/dashboard.svelte) -->
9
+
10
+ ## 概要
11
+ 1. <TBD/>
12
+
13
+ ## 画面イメージ
14
+ 1. <TBD/>
15
+
16
+ ## 項目説明
17
+ 1. <TBD/>
@@ -0,0 +1,20 @@
1
+ ---
2
+ id: index
3
+ sidebar_position: 1
4
+ hide_table_of_contents: true
5
+ ---
6
+ import { TBD } from '@site/src/components/TBD';
7
+
8
+ # 画面定義
9
+ ## 画面一覧
10
+
11
+ | Physical name | Logical name | Summyry | Comment |
12
+ | -------------------------- | -------------- | ------- | ------- |
13
+ | [login](login.mdx) | ログイン | - | |
14
+ | └ registration | 新規登録 | - | |
15
+ | └ update-password | パスワード更新 | - | |
16
+ | [menu](menu.mdx) | メニュー | - | |
17
+ | [dashboard](dashboard.mdx) | ダッシュボード | - | |
18
+
19
+ ## 画面遷移
20
+ <TBD/>
@@ -0,0 +1,18 @@
1
+ ---
2
+ sidebar_position: 2
3
+ ---
4
+ import { TBD } from '@site/src/components/TBD';
5
+
6
+ # ログイン
7
+ ## ファイル
8
+ <!-- 1. frontend/src/routes/[login.svelte](../../../../frontend/src/routes/login.svelte) -->
9
+
10
+ ## 概要
11
+ 1. ログイン画面
12
+ 1. セッションなし
13
+
14
+ ## 画面イメージ
15
+ 1. <TBD/>
16
+
17
+ ## 項目説明
18
+ 1. <TBD/>
@@ -0,0 +1,17 @@
1
+ ---
2
+ sidebar_position: 3
3
+ ---
4
+ import { TBD } from '@site/src/components/TBD';
5
+
6
+ # メニュー
7
+ ## ファイル
8
+ <!-- 1. frontend/src/routes/[menu.svelte](../../../../frontend/src/routes/menu.svelte) -->
9
+
10
+ ## 概要
11
+ 1. メニュー画面
12
+
13
+ ## 画面イメージ
14
+ 1. <TBD/>
15
+
16
+ ## 項目説明
17
+ 1. <TBD/>
@@ -0,0 +1,2 @@
1
+ label: 'テーブル定義'
2
+ position: 6
@@ -0,0 +1,35 @@
1
+ ---
2
+ sidebar_position: 3
3
+ hide_table_of_contents: true
4
+ ---
5
+ import TOCInline from '@theme/TOCInline';
6
+
7
+ # customer_details - 会員詳細
8
+
9
+ <details>
10
+ <summary>目次</summary>
11
+
12
+ <TOCInline toc={toc} />
13
+ </details>
14
+
15
+ ## 説明 {#description}
16
+ 1. xxxの会員詳細
17
+ 1. 会員の電話番号、住所など
18
+
19
+ ## 表領域(schema) {#schema}
20
+ 1. `public`
21
+
22
+ ## 定義 {#definition}
23
+
24
+ | Physical name | Logical name | Type | Digit | Not null | Default value | Comment |
25
+ | ---------------- | ------------ | --------- | ----: | :------: | ----------------- | ------- |
26
+ | id | ID | serial | - | :o: | | |
27
+ | customer_id | 顧客ID | varchar | 100 | :o: | | |
28
+ | phone_number | 電話番号 | varchar | 12 | :o: | | |
29
+ | postal_code | 郵便番号 | varchar | 8 | :o: | | |
30
+ | address_1 | 住所1 | varchar | 500 | :o: | | |
31
+ | address_2 | 住所2 | varchar | 500 | :o: | | |
32
+ | created_id | 作成者ID | integer | - | :o: | | |
33
+ | created_at | 作成日時 | timestamp | - | :o: | current_timestamp | |
34
+ | last_modified_id | 更新者ID | integer | - | :o: | | |
35
+ | last_modified_at | 更新日時 | timestamp | - | :o: | current_timestamp | |
@@ -0,0 +1,35 @@
1
+ ---
2
+ sidebar_position: 2
3
+ hide_table_of_contents: true
4
+ ---
5
+ import TOCInline from '@theme/TOCInline';
6
+
7
+ # customers - 会員
8
+
9
+ <details>
10
+ <summary>目次</summary>
11
+
12
+ <TOCInline toc={toc} />
13
+ </details>
14
+
15
+ ## 説明 {#description}
16
+ 1. xxxの会員
17
+
18
+ ## 表領域(schema) {#schema}
19
+ 1. `public`
20
+
21
+ ## 定義 {#definition}
22
+
23
+ | Physical name | Logical name | Type | Digit | Not null | Default value | Comment |
24
+ | ------------------ | ------------ | --------- | ----: | :------: | ----------------- | ---------------------------- |
25
+ | id | ID | serial | - | :o: | | |
26
+ | login_id | ログインID | varchar | 255 | :o: | | |
27
+ | customer_number | 顧客番号 | varchar | 100 | :o: | | |
28
+ | password_encrypted | パスワード | varchar | 255 | :o: | | |
29
+ | is_enabled | is有効 | boolean | - | :o: | true | true:有効<br/>false:無効 |
30
+ | is_withdrawn | is退会 | boolean | - | :o: | false | true:退会済<br/>false:未退会 |
31
+ | withdrawn_at | 退会日時 | timestamp | - | - | | |
32
+ | created_id | 作成者ID | integer | - | - | | |
33
+ | created_at | 作成日時 | timestamp | - | :o: | current_timestamp | |
34
+ | last_modified_id | 更新者ID | integer | - | :o: | | |
35
+ | last_modified_at | 更新日時 | timestamp | - | :o: | current_timestamp | |
@@ -0,0 +1,11 @@
1
+ ---
2
+ sidebar_position: 1
3
+ hide_table_of_contents: true
4
+ ---
5
+ # テーブル定義
6
+ ## テーブル一覧
7
+
8
+ | Physical name | Logical name | Schema | Comment |
9
+ | ----------------------------------------- | ------------ | ------ | ------- |
10
+ | [customers](customers.mdx) | 会員 | public | |
11
+ | └[customer_details](customer_details.mdx) | 会員詳細 | public | |
@@ -0,0 +1,57 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <svg width="850" height="300" xmlns="http://www.w3.org/2000/svg" font-family="Arial, sans-serif">
3
+ <!-- 定義: 矢印マーカー -->
4
+ <defs>
5
+ <marker id="arrow" markerWidth="10" markerHeight="10" refX="10" refY="5" orient="auto">
6
+ <path d="M0,0 L10,5 L0,10 Z" fill="black" />
7
+ </marker>
8
+ </defs>
9
+
10
+ <!-- コンポーネント: User -->
11
+ <rect x="40" y="40" width="80" height="40" fill="#FFFFFF" stroke="#000000" />
12
+ <text x="80" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">User</text>
13
+
14
+ <!-- コンポーネント: Amazon Route 53 -->
15
+ <rect x="180" y="40" width="120" height="40" fill="#F9E79F" stroke="#F1C40F" />
16
+ <text x="240" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon Route 53</text>
17
+
18
+ <!-- コンポーネント: Amazon CloudFront -->
19
+ <rect x="330" y="40" width="120" height="40" fill="#D1F2EB" stroke="#1ABC9C" />
20
+ <text x="390" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon CloudFront</text>
21
+
22
+ <!-- コンポーネント: Elastic Load Balancer -->
23
+ <rect x="480" y="40" width="140" height="40" fill="#F5B7B1" stroke="#E74C3C" />
24
+ <text x="550" y="60" text-anchor="middle" dominant-baseline="middle" font-size="12">Elastic Load Balancer</text>
25
+
26
+ <!-- コンポーネント: EC2 (Auto Scaling) -->
27
+ <rect x="650" y="40" width="140" height="60" fill="#D6EAF8" stroke="#3498DB" />
28
+ <text x="720" y="70" text-anchor="middle" dominant-baseline="middle" font-size="12">EC2 (Auto Scaling)</text>
29
+
30
+ <!-- コンポーネント: Amazon RDS -->
31
+ <rect x="650" y="120" width="140" height="60" fill="#E8DAEF" stroke="#8E44AD" />
32
+ <text x="720" y="150" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon RDS</text>
33
+
34
+ <!-- コンポーネント: Amazon S3 -->
35
+ <rect x="650" y="200" width="140" height="60" fill="#FCF3CF" stroke="#F4D03F" />
36
+ <text x="720" y="230" text-anchor="middle" dominant-baseline="middle" font-size="12">Amazon S3</text>
37
+
38
+ <!-- 接続エッジ -->
39
+
40
+ <!-- User -> Amazon Route 53 -->
41
+ <line x1="120" y1="60" x2="180" y2="60" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
42
+
43
+ <!-- Amazon Route 53 -> Amazon CloudFront -->
44
+ <line x1="300" y1="60" x2="330" y2="60" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
45
+
46
+ <!-- Amazon CloudFront -> Elastic Load Balancer -->
47
+ <line x1="450" y1="60" x2="480" y2="60" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
48
+
49
+ <!-- Elastic Load Balancer -> EC2 (Auto Scaling) -->
50
+ <line x1="620" y1="60" x2="650" y2="70" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
51
+
52
+ <!-- EC2 (Auto Scaling) -> Amazon RDS -->
53
+ <line x1="670" y1="100" x2="720" y2="120" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
54
+
55
+ <!-- EC2 (Auto Scaling) -> Amazon S3 -->
56
+ <line x1="770" y1="100" x2="720" y2="200" stroke="black" stroke-width="2" marker-end="url(#arrow)" />
57
+ </svg>
@@ -0,0 +1,47 @@
1
+ ---
2
+ sidebar_position: 1
3
+ ---
4
+
5
+ # Tutorial Intro
6
+
7
+ Let's discover **Docusaurus in less than 5 minutes**.
8
+
9
+ ## Getting Started
10
+
11
+ Get started by **creating a new site**.
12
+
13
+ Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
14
+
15
+ ### What you'll need
16
+
17
+ - [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
18
+ - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
19
+
20
+ ## Generate a new site
21
+
22
+ Generate a new Docusaurus site using the **classic template**.
23
+
24
+ The classic template will automatically be added to your project after you run the command:
25
+
26
+ ```bash
27
+ npm init docusaurus@latest my-website classic
28
+ ```
29
+
30
+ You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
31
+
32
+ The command also installs all necessary dependencies you need to run Docusaurus.
33
+
34
+ ## Start your site
35
+
36
+ Run the development server:
37
+
38
+ ```bash
39
+ cd my-website
40
+ npm run start
41
+ ```
42
+
43
+ The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
44
+
45
+ The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
46
+
47
+ Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
@@ -0,0 +1,2 @@
1
+ label: 'ドキュメント編集方法'
2
+ position: 3
@@ -0,0 +1,31 @@
1
+ ---
2
+ sidebar_position: 1
3
+ tag:
4
+ - Markdown
5
+ ---
6
+
7
+ # 概要
8
+ ## フォルダー構成 {#folder-configuration}
9
+ ```
10
+ \
11
+ ```
12
+
13
+ ## サイドバー {#sidebar}
14
+ 1. mdx(md)ファイルで作成すると自動的にコンテンツとなる
15
+ 1. 表示順を変更したい場合はファイルの最初にyaml形式で定義する
16
+ 1. 参考: 公式Docusaurus.[Markdown front matter](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs#markdown-front-matter)
17
+ 1. 例
18
+ ```mdx title="sample.mdx"
19
+ ---
20
+ sidebar_position: 1
21
+ ---
22
+ # サンプル
23
+ ```
24
+
25
+ ## 階層表示したい場合 {#to-layerd}
26
+ 1. サブフォルダーを作成し、そこにファイル `_category_.yml` を作る
27
+ 1. 例
28
+ ```yml title="_category_.yml"
29
+ label: 'ドキュメント編集方法'
30
+ position: 4
31
+ ```
@@ -0,0 +1,35 @@
1
+ ---
2
+ id: index
3
+ sidebar_position: 1
4
+ hide_title: true
5
+ ---
6
+ import { TBD } from '@site/src/components/TBD';
7
+
8
+ # Introduction
9
+
10
+ :::tip
11
+ 1. このドキュメントサイトは各プロジェクトごとの作成例です
12
+ 1. ソースとドキュメントを一元管理する(できる)ことを示しています
13
+ :::
14
+
15
+ ## 参考になりそうな情報
16
+ 1. Qiita: [良いコードの書き方](https://qiita.com/alt_yamamoto/items/25eda376e6b947208996)
17
+ 1. コーディング規約のガイドラインとして参考にしたい
18
+ 1. Website: Qbook会員限定-[この一冊でソフトウェアテストの基本がわかる!](https://www.qbook.jp/e-book/software-kiso/)
19
+ 1. Qbook会員になると無料で読める
20
+ 1. テストについて資料したい場合の参考に
21
+ 1. Website(PDF): IPA情報処理推進機構-[事例3: 要件定義ドキュメントの漏れや曖昧性の低減](https://www.ipa.go.jp/archive/files/000072725.pdf)
22
+ 1. 要件定義に必要なこと、その後に作成するドキュメントの順番などがわかりやすく書かれている
23
+ 1. GitHub: [nablarch-development-standards](https://github.com/nablarch-development-standards/nablarch-development-standards)
24
+ 1. Nablarch開発標準
25
+ 1. Excelなどで書かれているドキュメント
26
+ 1. Officeドキュメントなのが残念だけど、書物としては参考にしやすそう
27
+
28
+ ## 気になるアプリケーションなど
29
+ 1. [Playwright](https://playwright.dev)
30
+ 1. TypeScriptで作られたE2Eテスト。
31
+ 1. メジャーなブラウザーをコレひとつでテストできるようになる
32
+ 1. 可能なら導入確認していきたい
33
+ 1. [Biome](https://biomejs.dev)
34
+ 1. Node.jsでのlintやフォーマッターをコレひとつで管理できるようしたもの
35
+ 1. Node.jsだとeslintが有名だけど、設定の面倒な部分や高速化したい時にBiomeの導入を検討したい
@@ -0,0 +1,2 @@
1
+ label: '運用ポリシー'
2
+ position: 2
@@ -0,0 +1,33 @@
1
+ ---
2
+ sidebar_position: 1
3
+ tag:
4
+ - Git
5
+ ---
6
+
7
+ # GitHub
8
+ 1. リポジトリは右上のGitHubアイコンをクリックする
9
+
10
+ ## 概要 {#overview}
11
+ 1. コンテンツの管理、IssueなどすべてをGitHubで行う
12
+
13
+ ## ブランチ命名ルール {#branch-naming}
14
+ 1. 基本はケバブケース(例: `feature/abc-def`)
15
+ 1. [`^(feature\/|bugfix\/|revert\/|cherry-pick\/)(issue-name-or-summary-[a-z0-9\-]*)$`](https://regexper.com/#%5E%28feature%5C%2F%7Cbugfix%5C%2F%7Crevert%5C%2F%7Ccherry-pick%5C%2F%29%28issue-name-or-summary-%5Ba-z0-9%5C-%5D*%29%24)
16
+ 1. ![img](img/branch-naming-rules.svg)
17
+ 1. 例
18
+ 1. `feature/issue123-frontend-add-lgoin`
19
+ 1. `feature/issue333-website-update-docusaurus-3-0-1`
20
+
21
+ ### `feature/`
22
+ 1. 以下を除くすべて
23
+
24
+ ### `bugfix/`
25
+ 1. バグ発生時の対応時に使用する
26
+ 1. ここでのバグは`main`へmerge後に発生したものを指す
27
+ 1. テスト中の発生したものは含まない
28
+
29
+ ### `revert/`
30
+ 1. revert時
31
+
32
+ ### `cherry-pick/`
33
+ 1. cherry-pick利用時