create-specment 0.2.8 → 0.2.9

package/templates/docs/01-overview/glossary.mdx

@@ -0,0 +1,41 @@
+---
+sidebar_position: 99
+tags:
+  - Glossary
+---
+import { TBD } from '@site/src/components/TBD';
+
+# Glossary - 用語集
+
+<!--
+TBDの使い方
+  <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
+  執筆完了後はimport文といっしょにこのコメントも必ず削除すること
+-->
+
+## 使い方ガイド {#how-to-use}
+1. 用語は **アルファベット順 → かな順 → その他** の順番で並べる  
+1. 別名・略語は `(別名: xxx)` と括弧書きで追記  
+
+## 用語一覧 {#glossary-list}
+
+:::tip TIP
+1. 以下は記述例
+1. すべての記述例を削除、もしくは編集したらこのTIPも削除する
+:::
+
+### API
+1. Application Programming Interface の略。ソフトウェア間の通信仕様
+1. REST, gRPC など
+
+### Availability
+1. システムの稼働率を示す指標
+1. 「可用性」とも呼ぶ
+
+### BPMN
+1. Business Process Model and Notation。業務プロセス図の標準表記
+1. PlantUML 等で描画可能  
+
+### キャパシティプランニング {#capacity-planning}
+1. 将来の負荷増加を見越した資源計画  
+1. CPU / メモリ / IOPS など  

package/templates/docs/01-overview/index.mdx

@@ -0,0 +1,41 @@
+---
+id: index
+sidebar_position: 1
+tags:
+  - Overview
+---
+# プロジェクト概要・分析
+
+1. プロジェクト上流工程に必要なドキュメントです
+1. 上から順に読み進めることで全体像を把握できます
+
+## フォルダー構成と役割 {#structure}
+
+:::tip TIP
+1. ファイル名に接頭辞 `_` を付けているテンプレートは、執筆開始時に接頭辞を外して本運用ファイルへリネームする  
+1. 使用しないテンプレがあれば削除し、以下の一覧からも解除する
+:::
+
+```text
+01-overview/
+├ index.mdx                     ← このファイル
+├ project-charter.mdx           ← 上位ビジョン・非ゴール
+├ odsc.mdx                      ← 目的(o)・成果物(d)・成功基準(sc)
+├ as-is.mdx                     ← 現状分析
+├ to-be.mdx                     ← 目指すべき姿
+├ scope.mdx                     ← 機能・非機能スコープ
+├ business-context.mdx          ← 市場・ユーザ・背景
+├ stakeholders.mdx              ← 役割責任表・RACI
+├ assumptions-constraints.mdx   ← 前提条件・制約
+├ gap-analysis.mdx              ← ギャップ分析
+├ risks.mdx                     ← リスク登録簿
+├ roadmap.mdx                   ← ロードマップ
+├ system-context.mdx            ← システムコンテキスト
+└ glossary.mdx                  ← 用語集
+```
+
+## ドキュメント作成ルール {#rules}
+1. 各ドキュメントは **章立て・箇条書き・コードブロック** の記法ルールに従う
+1. 未確定箇所には `<TBD/>` コンポーネントを置き、確定後に削除する
+1. 章タイトルのひとつ上の行に空行を入れる。ただし直前行が章タイトルの場合は不要  
+1. プロジェクトで使用する用語は **アルファベット順 → かな順 → その他** で管理し、差分比較しやすいように番号付きリストを用いる → [Glossary - 用語集](./glossary.mdx) を参照  

package/templates/docs/01-overview/odsc.mdx

@@ -0,0 +1,72 @@
+---
+sidebar_position: 3
+tags:
+  - ODSC
+---
+import { TBD } from '@site/src/components/TBD';
+
+# ODSC
+
+<!--
+TBDの使い方
+  <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
+  執筆完了後はimport文といっしょにこのコメントも必ず削除すること
+-->
+
+## ODSCとは？ {#what-is-odsc}
+1. 目的(O)、成果物(D)、成功基準(SC)のこと
+1. 目的と手段(システム)を分け、開発対象を明確化する
+    1. プロジェクトを進めていく中で完了までに目標にブレをなくすのが目的
+
+## 目的 - Objectives {#objectives}
+
+:::tip TIP
+1. このプロジェクトが完了した時に達成したい目標を定量的に記述する
+1. ビジネスとしての目標とシステムとしての目標を書く
+    1. ビジネス目標
+        1. システムを含む全体像としてお客様や解決したい問題・課題を明記する
+        1. システムはこの目標を達成するための手段なので、明記することでブレをなくす
+    1. システムの目標
+        1. ソリューションの中でこのシステムが担う部分、システム化することで達成したい目標を明記する
+1. 記載できたらこのtipブロックを削除する
+:::
+
+1. ビジネス目標
+    1. <TBD/>
+1. システム目標
+    1. <TBD/>
+
+### 非ゴール - Out of Scope {#out-of-scope}
+1. 例: モバイルネイティブアプリの UI 実装
+1. 例: 店舗在庫とのリアルタイム同期
+
+## 成果物 - Deliverables {#deliverables}
+
+:::tip TIP
+1. 基本はシステムそのもの、そのマニュアルなど。プロジェクト完了後にお客様へ提供するもの
+1. 設計書を要求された場合、その意図を明確にする
+    1. 他社開発ベンダーへの引き継ぎの場合 -> このドキュメント含めたrepositoryで済む
+    1. Officeドキュメント、pdfを要求された場合の対応を考慮しておく
+1. 反対にシステム化しないことも明記する
+    1. その理由も明記し、プロジェクト途中でタスク追加されるリスクを減らす
+1. 記載できたらこのtipブロックを削除する
+:::
+
+1. <TBD/> 参照
+
+## 成功基準 - Success Criteria {#success-criteria}
+
+:::tip TIP
+1. 定量目標。数値による結果で判定できるようにすることで評価できるようにする
+1. 例
+    1. ピーク時のスケールサーバー数がx台以下、利用額がxxxドル以下、など
+    1. リリース後1ヶ月以内にサーバーエラーによるシステム断時間がx時間以下
+1. プロジェクト中盤で達成が難しいと分かった場合はその時点で再定義し、お客様と合意を得る
+1. 記載できたらこのtipブロックを削除する
+:::
+
+| # | 指標 | 目標値 | 期限 | 測定方法 |
+| - | ---- | ------ | ---- | -------- |
+| SC-01 | 例: 決済成功率 | 95 %以上 | GA +1 か月 | Datadog APM |
+| SC-02 | 例: 平均応答時間 | 200 ms 以下 | ベータ期間 | k6 & Grafana |
+| SC-03 | 例: NPS | +15 | GA +3 か月 | アンケート |

package/templates/docs/01-overview/roadmap.mdx

@@ -0,0 +1,27 @@
+---
+sidebar_position: 12
+tags:
+  - Overview
+  - Roadmap
+---
+# ロードマップ {#roadmap}
+
+import Gantt from '@site/static/img/gantt.drawio.svg';
+
+## マスタースケジュール {#master-schedule}
+<Gantt aria-label='マスタースケジュール' width='100%' height='auto' role='img' />
+
+## マイルストーン {#milestones}
+
+| フェーズ | 期間 | 主な成果物 |
+| ------- | ---- | ---------- |
+| 準備 | 2025-05 | 要件定義完了 |
+| 開発 | 2025-06 〜 2025-09 | Betaリリース |
+
+## リリース計画 {#release-plan}
+1. Alpha: 2025-07
+1. Beta: 2025-09
+1. GA: 2025-12
+
+## 依存関係 {#dependencies}
+1. 決済ゲートウェイv2公開

package/templates/docs/01-overview/system-context.mdx

@@ -0,0 +1,22 @@
+---
+sidebar_position: 13
+tags:
+  - Overview
+  - Architecture
+---
+
+# システムコンテキスト {#system-context}
+
+## コンテキスト図 {#context-diagram}
+```pumld
+@startuml
+!include <C4/C4_Container>
+System_Boundary(ec, "EC System") {
+  Container(web, "Web Frontend")
+  Container(api, "API Server")
+}
+System(billing, "Payment Gateway")
+Rel(web, api, "HTTPS/JSON")
+Rel(api, billing, "REST")
+@enduml
+```

package/templates/docs/01-overview/to-be.mdx

@@ -0,0 +1,102 @@
+---
+sidebar_position: 5
+tags:
+  - To-Be
+---
+import { TBD } from '@site/src/components/TBD';
+
+# To‑Be - 目指すべき姿
+
+<!--
+TBDの使い方
+  <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
+  執筆完了後はimport文といっしょにこのコメントも必ず削除すること
+-->
+
+## 概要 {#target-overview}
+1. 本章で示す「理想状態」と As‑Is との差分を概観する  
+1. ビジネス価値・ユーザ価値・システム観点を 1‒2 文でまとめる
+
+## 改善後業務フロー {#business-flow}
+
+:::tip
+1. BPMN やスイムレーン図で将来の業務プロセスを可視化  
+1. PlantUML を直接埋め込むか、drawio・外部リンクでも可
+:::
+
+```pumld
+@startuml
+skinparam ParticipantPadding 20
+skinparam Shadowing false
+
+|顧客|
+start
+:商品閲覧;
+:ワンクリック購入;
+|ECシステム|
+:在庫自動確保;
+:決済トークン発行;
+|決済ゲートウェイ|
+:即時決済承認;
+|ECシステム|
+:出荷指示;
+|倉庫WMS|
+:自動ピッキング;
+|顧客|
+stop
+@enduml
+```
+
+## システム全体像 {#system-architecture}
+
+```pumld
+@startuml
+!include <C4/C4_Container>
+
+System_Boundary(ec, "EC System") {
+  Container(web, "Next.js Frontend", "TypeScript/React")
+  Container(api, "API Server", "Go + gRPC")
+  ContainerDb(db, "PostgreSQL", "Cloud SQL", "商品・注文DB")
+}
+System_Ext(billing, "Payment Gateway")
+System_Ext(cd, "CDN")
+
+Rel(web, api, "gRPC+JSON")
+Rel(api, db, "JDBC")
+Rel(api, billing, "REST")
+Rel(web, cd, "HTTPS (static assets)")
+@enduml
+```
+
+1. <TBD/> (詳細なサブシステム図や構成表を追加)
+
+## 主要機能一覧 {#features}
+
+| # | 機能 | 概要 | 優先度 |
+| - | ---- | ---- | ------ |
+| F‑01 | リアルタイム在庫同期 | ERP から Webhook で在庫更新 | High |
+| F‑02 | ワンクリック購入 | 顧客の決済トークンを再利用 | High |
+| F‑03 | レコメンド | 行動ログを用いた個別提案 | Medium |
+
+## 非機能要求サマリ {#non-functional-requirements}
+
+| 項目 | 目標値 | 備考 |
+| ---- | ------ | ---- |
+| 可用性 | 99.9 %以上 | マルチ AZ |
+| 性能 | 平均応答 200 ms 以下 | Peak 500 ms 以下 |
+| セキュリティ | OWASP Top‑10 準拠 | WAF / CSP |
+
+## 移行方針・ロードマップ {#migration-strategy}
+
+1. **フェーズ1: MVP**  
+    1. カタログ閲覧 + 決済 (限定 SKU)
+1. **フェーズ2: Full Launch**  
+    1. 全 SKU 移行・レコメンド ON
+1. **フェーズ3: Continuous Improvement**  
+    1. A/B テスト・パフォーマンス最適化
+
+## 期待効果・成功要因 {#expected-effects}
+
+1. 売上 +20 %、離脱率 15 % → 8 %
+1. 運用工数 月 40 h 削減
+1. ユーザ満足度 (NPS) +15

package/templates/docs/02-requirements/_category_.yaml

@@ -0,0 +1,2 @@
+label: '要件定義'
+position: 1

package/templates/docs/02-requirements/functional/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "要件定義一覧",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "こんなことやあんなこと"
+  }
+}

package/templates/docs/02-requirements/functional/_req-template.mdx

@@ -0,0 +1,49 @@
+---
+id: req-001
+title: 要求タイトル
+sidebar_label: REQ-001：要求タイトル
+description: 要求の簡単な説明
+tags: [タグ1, タグ2]
+urgency: 5
+importance: 5
+draft: true
+---
+import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
+import { TagList } from '@site/src/components/Tag';
+
+<TagList tags={frontMatter.tags} />
+
+<!-- <div style={{ marginBottom: "1rem" }}>
+  {frontMatter.tags.map((tag) => (
+    <Tag key={tag} name={tag} />
+  ))}
+</div> -->
+
+## 概要
+<!-- 1-2文で要求の概要を記述 -->
+
+## 詳細要件
+<!-- 箇条書きで具体的な要件を記述 -->
+- 要件1
+- 要件2
+- 要件3
+
+## 受け入れ基準
+<!-- この要求が満たされたと判断できる基準を記述 -->
+- [ ] 基準1
+- [ ] 基準2
+
+## 関連する非機能要件
+<!-- 関連するNFRへのリンク -->
+- [NFR-001：パフォーマンス要件](../non-functional/nfr-001.mdx)
+
+## 参考情報
+<!-- 追加の情報、図表、リンクなど -->
+
+export const changes = [
+  {
+    date: "2025-01-02",
+    author: "作成者名",
+    changes: "初版作成",
+  },
+]

package/templates/docs/02-requirements/functional/req-001.mdx

@@ -0,0 +1,56 @@
+---
+id: req-001
+title: ユーザー認証機能
+sidebar_label: REQ-001：ユーザー認証
+description: システムへのアクセスを制御するための認証機能
+tags: [認証, セキュリティ, ユーザー管理]
+urgency: 7
+importance: 8
+---
+import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
+import { TagList } from '@site/src/components/Tag';
+// import { ChangeHistoryComponent } from '@site/src/components/ChangeHistory';
+
+<TagList tags={frontMatter.tags} />
+
+<PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
+
+<!-- <div style={{ marginBottom: "1rem" }}>
+  {frontMatter.tags.map((tag) => (
+    <Tag key={tag} name={tag} />
+  ))}
+</div> -->
+
+## 概要
+システムへのアクセスを制御するためのユーザー認証機能を提供する。
+
+## 詳細要件
+1. ユーザーはメールアドレスとパスワードでログインできること
+1. パスワードは8文字以上であること
+1. 2要素認証に対応すること
+1. パスワードリセット機能を提供すること
+
+## 受け入れ基準
+- [ ] 正しい認証情報でログインできる
+- [ ] 誤った認証情報ではログインできない
+- [ ] パスワードリセットメールが送信される
+- [ ] 2要素認証が正常に機能する
+
+## 関連する非機能要件
+1. [NFR-001：セキュリティ要件](../non-functional/nfr-001.mdx)
+1. [NFR-002：パフォーマンス要件](../non-functional/nfr-002.mdx)
+
+## 参考情報
+- [OWASP認証のベストプラクティス](https://owasp.org/)
+
+## 更新履歴
+
+export const changes = [
+  {
+    date: "2025-01-02",
+    author: "作成者名",
+    changes: "初版作成",
+  },
+]
+
+{/* <ChangeHistoryComponent changes={changes} /> */}

package/templates/docs/02-requirements/index.mdx

@@ -0,0 +1,14 @@
+---
+id: index
+sidebar_position: 1
+---
+# 要件定義
+
+:::note Note
+1. 編集途中
+:::
+
+:::tip Tip
+1. 要件定義の目的はシステムが完成した時のイメージを共有すること
+1. 成果物の認識がブレてしまうと、時間のロス、果ては作り直しになってしまうこともある
+:::

package/templates/docs/02-requirements/non-functional/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "非機能要件一覧",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "非機能のあれやこれ"
+  }
+}

package/templates/docs/02-requirements/non-functional/_nfr-template.mdx

@@ -0,0 +1,45 @@
+---
+id: nfr-template
+title: 非機能要件テンプレート
+sidebar_label: NFR-XXX：タイトル
+description: 非機能要件の説明
+tags: [タグ1, タグ2]
+draft: true
+---
+
+import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
+import { TagList } from '@site/src/components/Tag';
+import { ChangeHistoryComponent } from '@site/src/components/ChangeHistory';
+
+<TagList tags={frontMatter.tags} />
+
+<PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
+
+## 概要
+<!-- 非機能要件の概要を記述 -->
+
+## 詳細要件
+### カテゴリ1
+<!-- 要件の詳細を記述 -->
+
+### カテゴリ2
+<!-- 要件の詳細を記述 -->
+
+## 測定方法
+<!-- 要件の達成を測定する方法を記述 -->
+
+## 制約条件
+<!-- 制約条件があれば記述 -->
+
+## 関連する機能要件
+<!-- 関連する機能要件へのリンク -->
+
+export const changes = [
+  {
+    date: "2025-01-02",
+    author: "作成者名",
+    changes: "初版作成",
+  },
+]
+
+<ChangeHistoryComponent changes={changes} />

package/templates/docs/02-requirements/non-functional/nfr-001.mdx

@@ -0,0 +1,60 @@
+---
+id: nfr-001
+title: セキュリティ要件
+sidebar_label: NFR-001：セキュリティ要件
+description: システム全体のセキュリティに関する非機能要件
+tags: [セキュリティ, SLA]
+urgency: 9
+importance: 9
+---
+
+import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
+import { TagList } from '@site/src/components/Tag';
+
+<TagList tags={frontMatter.tags} />
+
+<PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
+
+## 概要
+システム全体のセキュリティに関する要件を定義する。
+
+## 性能要件
+### レスポンス時間
+1. 画面表示：2秒以内
+1. API応答：1秒以内
+1. バッチ処理：指定された時間枠内で完了
+
+### スループット
+1. 同時接続ユーザー数：1000ユーザー
+1. トランザクション処理：100 TPS
+
+### リソース使用
+1. CPU使用率：平常時80%以下
+1. メモリ使用率：平常時70%以下
+1. ストレージ使用率：80%以下
+
+## 監視要件
+1. APMツールによる常時監視
+1. パフォーマンスメトリクスの収集
+1. アラート閾値の設定
+
+## 測定方法
+1. 負荷テストツール：JMeter
+1. 監視ツール：Datadog
+1. 測定間隔：5分
+
+## 関連する機能要件
+1. [REQ-001：ユーザー認証](../functional/req-001.mdx)
+
+export const changes = [
+  {
+    date: "2024-01-15",
+    author: "鈴木次郎",
+    changes: "監視要件の追加",
+  },
+  {
+    date: "2024-01-01",
+    author: "山田太郎",
+    changes: "初版作成",
+  },
+]

package/templates/docs/02-requirements/non-functional/nfr-002.mdx

@@ -0,0 +1,60 @@
+---
+id: nfr-002
+title: システムパフォーマンス要件
+sidebar_label: NFR-002：パフォーマンス
+description: システム全体のパフォーマンスに関する非機能要件
+tags: [パフォーマンス, SLA]
+urgency: 4
+importance: 8
+---
+
+import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
+import { TagList } from '@site/src/components/Tag';
+
+<TagList tags={frontMatter.tags} />
+
+<PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
+
+## 概要
+システム全体のパフォーマンスに関する要件を定義する。
+
+## 性能要件
+### レスポンス時間
+1. 画面表示：2秒以内
+1. API応答：1秒以内
+1. バッチ処理：指定された時間枠内で完了
+
+### スループット
+1. 同時接続ユーザー数：1000ユーザー
+1. トランザクション処理：100 TPS
+
+### リソース使用
+1. CPU使用率：平常時80%以下
+1. メモリ使用率：平常時70%以下
+1. ストレージ使用率：80%以下
+
+## 監視要件
+1. APMツールによる常時監視
+1. パフォーマンスメトリクスの収集
+1. アラート閾値の設定
+
+## 測定方法
+1. 負荷テストツール：JMeter
+1. 監視ツール：Datadog
+1. 測定間隔：5分
+
+## 関連する機能要件
+1. [REQ-001：ユーザー認証](../functional/req-001.mdx)
+
+export const changes = [
+  {
+    date: "2024-01-15",
+    author: "鈴木次郎",
+    changes: "監視要件の追加",
+  },
+  {
+    date: "2024-01-01",
+    author: "山田太郎",
+    changes: "初版作成",
+  },
+]

package/templates/docs/03-external/business-model.mdx

@@ -0,0 +1,14 @@
+---
+sidebar_position: 2
+hide_table_of_contents: true
+---
+# ビジネスモデル図
+
+import BusinessModel from '@site/static/img/business-model.drawio.svg';
+
+<BusinessModel aria-label='ビジネスモデル' width='100%' height='auto' role='img' />
+
+1. 参考
+    1. https://drawio-app.com/blog/business-model-canvas/
+    1. note: 『ビジネスの仕組みがわかる 図解のつくりかた』全文公開
+        1. https://note.com/bizgram/n/n3dbed12f95ea