create-specment 0.4.0 → 0.5.0

package/README.md

@@ -1,15 +1,15 @@
 # create-specment
 
-[![NPM Package](.github/images/icons/npm-badge.svg)](https://www.npmjs.com/package/@plenarc/create-specment)
-[![MIT License](.github/images/icons/license-badge.svg)](LICENSE)
+[![npm version][npm-image]][npm-url]
+[![npm downlads][npm-downloads-image]][npm-url]
+[![License][license-image]][license-url]
 
 [English](README.md) | [日本語](README-jp.md)
 
 Demo: https://plenarc.github.io/specment/
 
 1. 'specification' + 'document' => Specment
-1. A site generation tool specializing in creating specification documents based on Docusaurus.
-
+1. A site generation tool specializing in creating specification documents based on Docusaurus
 
 <div align="center">
   <table>
@@ -40,7 +40,7 @@ Demo: https://plenarc.github.io/specment/
 ## Features
 
 1. 🚀 **Interactive Setup**: Generate projects by simply answering questions
-1. 📋 **4 Specialized Templates**: Choose optimal templates based on your use case
+1. 📋 **5 Specialized Templates**: Choose optimal templates based on your use case
 1. 🔧 **Feature Selection**: Select PlantUML, Redoc, search, multilingual support, and more
 1. 📝 **Variable Substitution**: Automatically replace project names and author information
 1. 🎨 **Docusaurus Compatible**: Fully compatible with the existing Docusaurus ecosystem
@@ -61,15 +61,22 @@ The following software must be installed:
     ```
 
 1. **mise (development environment management tool)**
-
-    ```bash
-    # Install mise (Linux/macOS/WSL)
-    curl https://mise.run | sh
-
-    # Update shell configuration
-    echo 'eval "$(mise activate bash)"' >> ~/.bashrc
-    source ~/.bashrc
-    ```
+    1. Linux/macOS/WSL
+        ```bash
+        curl https://mise.run | sh
+
+        # Update shell configuration
+        echo 'eval "$(mise activate bash)"' >> ~/.bashrc
+        source ~/.bashrc
+        ```
+    1. brew
+        ```bash
+        brew install mise
+        ```
+    1. Version check
+        ```bash
+        mise --version
+        ```
 
 1. **Node.js (LTS or higher recommended, installation via mise recommended)**
 
@@ -94,143 +101,197 @@ The following software must be installed:
 
 ### Installation Methods
 
+1. For details on each option, see [Option Details](#option-details)
+
 #### Method 1: Using ni (Recommended)
 
 ```bash
-# Create project using ni
-nlx create-specment@latest my-docs
-cd my-docs
+# Create project using ni (interactive setup will start)
+nlx create-specment@latest
+```
 
-# Install dependencies using ni
-ni
+After execution, the following options will be displayed, so select the necessary documents and features:
 
-# Start development server using ni
-nr start
+```bash
+◆  Please select display language / 表示言語を選択してください:
+│  ● English
+│  ○ 日本語
+└
+
+┌  🚀 Welcome to create-specment!
+Creating a new Docusaurus-based specification documentation project...
+│
+◆  Enter folder name (project name):
+│  _
+└
+
+◆  Which templates would you like to use? (Multiple selection)
+│  ◻ Project Analysis
+│  ◻ Requirements Specification
+│  ◻ External Design
+│  ◻ Internal Design
+│  ◻ API (Using Redocusaurus)
+└
+
+◆  Which additional features would you like to include?
+│  ◻ PlantUML
+│  ◻ Mermaid
+└
 ```
 
-#### Method 2: Using npx
+Once creation is complete, change to the folder and start in development mode after installation:
 
 ```bash
-# Create project using the latest version
-npx create-specment@latest my-docs
-
-# Specify a specific template
-npx create-specment@latest my-docs --template api-spec
+cd <folder-name> && ni && nr start
 ```
 
-#### Method 3: Global Installation
+#### Method 2: Using npx
 
 ```bash
-# Install globally
-npm install -g create-specment
-
-# Create project
-create-specment my-docs
+# Start setup
+npx create-specment@latest
 ```
 
-### Basic Usage
+1. For option details, see Method 1
 
-1. **Create Project**
+## Interactive Setup
 
-    ```bash
-    nlx create-specment@latest my-docs
-    cd my-docs
-    ```
+When you run `create-specment`, the following options will be displayed sequentially:
 
-1. **Interactive Setup**
+### 1. Display Language Selection
 
-    Configure your project by answering the following questions:
+```
+◆ Please select display language / 表示言語を選択してください:
+│ ● English
+│ ○ 日本語
+```
 
-    1. **Language Selection**: Choose display language (English/Japanese)
-    1. **Project Name**: Name of your documentation site
-    1. **Template Selection**: Choose templates based on your use case (multiple selection)
-    1. **Feature Selection**: Select the features you need
+1. Select the display language for the interface
+1. Subsequent questions will be displayed in the selected language
 
-1. **Start Development Server**
+### 2. Project Name Input
 
-    ```bash
-    # Install dependencies (if not automatically executed)
-    ni
+```
+◆ Enter folder name (project name):
+│ _
+```
 
-    # Start development server
-    nr start
-    ```
+1. Enter the folder name for the project to be created
+1. This name will become the project directory name
 
-1. **Build and Deploy**
+### 3. Template Selection (Multiple selection possible)
 
-    ```bash
-    # Production build
-    nr build
+```
+◆ Which templates would you like to use? (Multiple selection)
+│ ◻ Project Analysis (Provides structure for understanding project overview)
+│ ◻ Requirements Specification
+│ ◻ External Design
+│ ◻ Internal Design
+│ ◻ API (Using Redocusaurus)
+```
 
-    # Local preview
-    nr serve
-    ```
+1. Multiple templates can be selected simultaneously
+1. Each template is generated as an independent section
+1. At least one template must be selected
 
-## Template List
+#### Project Analysis
 
-### 1. Classic Specification (classic-spec)
-General-purpose specification template. Provides basic document structure.
+Project overview and analysis template. Provides structure for understanding the overall picture of the project.
 
 **Use Cases**:
-1. General technical specifications
-1. Product specifications
-1. Basic documentation creation
+1. Project proposals
+1. Current state analysis reports
+1. SWOT analysis documents
 
-### 2. API Specification (api-spec)
-API specification template. Specialized for API documentation and OpenAPI specifications.
+#### Requirements Specification
+Requirements specification template. Allows systematic organization of functional and non-functional requirements.
 
 **Use Cases**:
-1. REST API documentation
-1. OpenAPI specifications
-1. API reference guides
+1. System requirements specifications
+1. Functional specifications
+1. EARS format requirement descriptions
+
+#### External Design
 
-### 3. Technical Specification (technical-spec)
-Technical specification template. Focused on detailed technical documentation and system design.
+External design specification template. Specialized for interface design with external systems.
 
 **Use Cases**:
-1. System requirements documentation
-1. Functional specifications
-1. EARS format requirement descriptions
+1. System architecture design documents
+1. API design documents
+1. UI/UX design documents
+
+#### Internal Design
 
-### 4. Enterprise Specification (enterprise-spec)
-Enterprise specification template. Designed for large-scale enterprise documentation with comprehensive structure.
+Internal design specification template. Specialized for detailed internal system design and algorithms.
 
 **Use Cases**:
-1. Enterprise system architecture documentation
-1. Comprehensive project documentation
-1. Multi-stakeholder documentation
+1. Detailed design documents
+1. Database design documents
+1. Algorithm specifications
 
-## Feature Selection
+#### API
 
-### PlantUML Integration
-Easily create UML diagrams and sequence diagrams.
+1. Using [Redocusaurus](https://github.com/rohit-gohri/redocusaurus), you can display YAML format files written in OpenAPI specifications
 
-```plantuml
-@startuml
-Alice -> Bob: Hello
-Bob -> Alice: Hi!
-@enduml
+### 4. Additional Feature Selection
+
+```
+◆ Which additional features would you like to include?
+│ ◻ PlantUML (PlantUML diagram integration (UML diagrams and flowcharts))
+│ ◻ Mermaid
 ```
 
-### Redoc Integration
-Beautifully display OpenAPI specifications.
+1. **PlantUML**: Adds functionality to create UML diagrams and flowcharts
+1. **Mermaid**: Adds functionality to create diagrams within Markdown
+1. Both can be selected
+
+#### PlantUML
+
+1. You can use [PlantUML](https://plantuml.com/) for UML diagrams and sequence diagrams
+1. Uses the Docusaurus theme [create-specment](https://www.npmjs.com/package/create-specment)
+    1. ※ Please refer to the README at the link for usage and precautions
+
+#### Mermaid
+
+1. Uses the Docusaurus theme [theme-mermaid](https://docusaurus.io/docs/api/themes/@docusaurus/theme-mermaid)
 
-### Multilingual Support
-Support for creating documentation in multiple languages.
+#### Multilingual Support
+
+TBD: Plans to support document creation in multiple languages (if requested)
 
 ## Command Line Options
 
 ```bash
 create-specment [project-name] [options]
 
+Arguments:
+  project-name          Folder name for the project to be created (optional)
+                        When specified: Skip folder name input
+
 Options:
-  --template <template>  Template to use (classic-spec|api-spec|technical-spec|enterprise-spec)
+  -t, --template <template>  Template to use (project-analysis|requirements|external-design|internal-design|api-spec)
   --skip-install        Skip dependency installation
   --verbose             Show detailed logs
   -h, --help           Show help
   -V, --version        Show version
 ```
 
+### Usage Examples
+
+```bash
+# Complete interactive setup (all options will be displayed)
+create-specment
+
+# Specify folder name and interactive setup (skip folder name input)
+create-specment my-docs
+
+# Completely non-interactive (skip folder name and template selection)
+create-specment my-docs --template requirements
+
+# Specify template only (folder name input will be displayed)
+create-specment --template api-spec
+```
+
 ## Troubleshooting
 
 ### Common Issues
@@ -293,28 +354,6 @@ nr start -- --port 3001
     1. The combination of mise + ni minimizes environment differences
     1. Running as a Linux environment within WSL provides an experience equivalent to macOS/Linux
 
-## Development Environment Setup
-
-To participate in project development:
-
-```bash
-# Clone repository
-git clone https://github.com/plenarc/create-specment.git
-cd create-specment
-
-# Install dependencies
-ni
-
-# Run in development mode
-nr dev
-
-# Run tests
-nr test
-
-# Build
-nr build
-```
-
 ## License
 
 MIT License - See the [LICENSE](LICENSE) file for details.
@@ -329,10 +368,16 @@ We welcome contributions to the project! See [CONTRIBUTING.md](CONTRIBUTING.md)
 1. 💡 **Feature Requests**: [GitHub Discussions](https://github.com/plenarc/create-specment/discussions)
 1. 📖 **Documentation**: [Official Documentation](https://create-specment.dev)
 
-## Related Projects
+## Related projects
 
 1. [Docusaurus](https://docusaurus.io/) - Static site generator
 1. [mise](https://mise.jdx.dev/) - Development environment management tool
 1. [ni](https://github.com/antfu/ni) - Package manager unification tool
 1. [PlantUML](https://plantuml.com/) - UML diagram creation tool
 1. [Redoc](https://redocly.github.io/redoc/) - OpenAPI specification display tool
+
+[npm-image]: https://img.shields.io/npm/v/create-specment.svg
+[npm-url]: https://www.npmjs.com/package/create-specment
+[npm-downloads-image]: https://img.shields.io/npm/dw/create-specment.svg
+[license-image]: https://img.shields.io/github/license/plenarc/create-specment.svg
+[license-url]: https://github.com/plenarc/create-specment/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-specment",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Interactive CLI tool for creating Docusaurus-based specification documentation projects",
   "type": "module",
   "author": "Plenarc",
@@ -41,13 +41,13 @@
   "dependencies": {
     "@clack/prompts": "^0.11.0",
     "chalk": "^5.6.2",
-    "commander": "^14.0.2"
+    "commander": "^14.0.3"
   },
   "devDependencies": {
-    "@biomejs/biome": "^2.3.10",
-    "@types/node": "^25.0.3",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.16"
+    "@biomejs/biome": "^2.4.16",
+    "@types/node": "^25.5.2",
+    "typescript": "~6.0.3",
+    "vitest": "^4.1.8"
   },
   "engines": {
     "node": ">=22.0.0"

package/templates/docs/01-overview/as-is.mdx

@@ -7,11 +7,11 @@ import { TBD } from '@site/src/components/TBD';
 
 # As-Is - 現状分析
 
-<!--
+{/*
 TBDの使い方
   <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
   執筆完了後はimport文といっしょにこのコメントも必ず削除すること
--->
+*/}
 
 ## 概要 {#current-overview}
 1. 本章の目的と読み手が得られるアウトプットを記述

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

@@ -7,11 +7,11 @@ import { TBD } from '@site/src/components/TBD';
 
 # Glossary - 用語集
 
-<!--
+{/*
 TBDの使い方
   <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
   執筆完了後はimport文といっしょにこのコメントも必ず削除すること
--->
+*/}
 
 ## 使い方ガイド {#how-to-use}
 1. 用語は **アルファベット順 → かな順 → その他** の順番で並べる  

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

@@ -7,11 +7,11 @@ import { TBD } from '@site/src/components/TBD';
 
 # ODSC
 
-<!--
+{/*
 TBDの使い方
   <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
   執筆完了後はimport文といっしょにこのコメントも必ず削除すること
--->
+*/}
 
 ## ODSCとは？ {#what-is-odsc}
 1. 目的(O)、成果物(D)、成功基準(SC)のこと

package/templates/docs/01-overview/swot-analysis.mdx

@@ -39,7 +39,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
 ## SWOT分析結果
 
 ### Strengths (強み)
-<!-- 内部環境のプラス要因 -->
+{/* 内部環境のプラス要因 */}
 
 1. **技術力**
     1. 高度な技術スキルを持つエンジニアチーム
@@ -55,7 +55,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. 豊富なドメイン知識
 
 ### Weaknesses (弱み)
-<!-- 内部環境のマイナス要因 -->
+{/* 内部環境のマイナス要因 */}
 
 1. **技術面**
     1. 特定技術領域での経験不足
@@ -71,7 +71,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. 変更管理の仕組み不足
 
 ### Opportunities (機会)
-<!-- 外部環境のプラス要因 -->
+{/* 外部環境のプラス要因 */}
 
 1. **市場環境**
     1. デジタル化需要の拡大
@@ -87,7 +87,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. 業界ガイドラインの整備
 
 ### Threats (脅威)
-<!-- 外部環境のマイナス要因 -->
+{/* 外部環境のマイナス要因 */}
 
 1. **競合環境**
     1. 競合他社の技術力向上
@@ -105,7 +105,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
 ## 戦略マトリックス
 
 ### SO戦略 (強み × 機会)
-<!-- 強みを活かして機会を捉える戦略 -->
+{/* 強みを活かして機会を捉える戦略 */}
 
 1. **技術力を活かした新サービス展開**
     1. 高度な技術力を活用してデジタル化需要に対応
@@ -115,7 +115,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. パートナー企業との連携強化
 
 ### WO戦略 (弱み × 機会)
-<!-- 弱みを改善して機会を捉える戦略 -->
+{/* 弱みを改善して機会を捉える戦略 */}
 
 1. **スキル強化による競争力向上**
     1. 新技術研修の実施
@@ -125,7 +125,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. ドキュメント化の推進
 
 ### ST戦略 (強み × 脅威)
-<!-- 強みを活かして脅威を回避する戦略 -->
+{/* 強みを活かして脅威を回避する戦略 */}
 
 1. **技術力による差別化**
     1. 競合他社との技術的差別化
@@ -135,7 +135,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. 顧客との長期的関係構築
 
 ### WT戦略 (弱み × 脅威)
-<!-- 弱みと脅威を最小化する戦略 -->
+{/* 弱みと脅威を最小化する戦略 */}
 
 1. **リスク軽減策の実施**
     1. 技術リスクの早期発見・対応
@@ -147,7 +147,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
 ## アクションプラン
 
 ### 短期施策 (3ヶ月以内)
-<!-- 短期的に実施すべき施策 -->
+{/* 短期的に実施すべき施策 */}
 
 1. **技術スキル強化**
     1. 新技術研修の計画・実施
@@ -157,7 +157,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. ドキュメントテンプレートの整備
 
 ### 中期施策 (6ヶ月以内)
-<!-- 中期的に実施すべき施策 -->
+{/* 中期的に実施すべき施策 */}
 
 1. **組織体制強化**
     1. 専門チームの設立
@@ -167,7 +167,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. 新規パートナーの開拓
 
 ### 長期施策 (1年以内)
-<!-- 長期的に実施すべき施策 -->
+{/* 長期的に実施すべき施策 */}
 
 1. **戦略的投資**
     1. 新技術への投資
@@ -179,7 +179,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
 ## 評価・見直し
 
 ### 評価指標
-<!-- SWOT分析結果の評価指標 -->
+{/* SWOT分析結果の評価指標 */}
 
 1. **技術力指標**
     1. 新技術習得率
@@ -192,7 +192,7 @@ SWOT分析は、内部環境と外部環境をプラス要因とマイナス要
     1. 顧客満足度
 
 ### 見直しサイクル
-<!-- SWOT分析の見直し頻度とタイミング -->
+{/* SWOT分析の見直し頻度とタイミング */}
 
 1. **四半期レビュー**: 戦略の進捗確認
 1. **半期レビュー**: SWOT要素の再評価

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

@@ -7,11 +7,11 @@ import { TBD } from '@site/src/components/TBD';
 
 # To‑Be - 目指すべき姿
 
-<!--
+{/*
 TBDの使い方
   <TBD/> コンポーネントは未確定項目を可視化するための占位マークです
   執筆完了後はimport文といっしょにこのコメントも必ず削除すること
--->
+*/}
 
 ## 概要 {#target-overview}
 1. 本章で示す「理想状態」と As‑Is との差分を概観する  

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

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

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

@@ -10,32 +10,32 @@ draft: true
 ---
 import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
 
-<!-- <div style={{ marginBottom: "1rem" }}>
+{/* <div style={{ marginBottom: "1rem" }}>
   {frontMatter.tags.map((tag) => (
     <Tag key={tag} name={tag} />
   ))}
-</div> -->
+</div> */}
 
 ## 概要
-<!-- 1-2文で要求の概要を記述 -->
+{/* 1-2文で要求の概要を記述 */}
 
 ## 詳細要件
-<!-- 箇条書きで具体的な要件を記述 -->
+{/* 箇条書きで具体的な要件を記述 */}
 - 要件1
 - 要件2
 - 要件3
 
 ## 受け入れ基準
-<!-- この要求が満たされたと判断できる基準を記述 -->
+{/* この要求が満たされたと判断できる基準を記述 */}
 - [ ] 基準1
 - [ ] 基準2
 
 ## 関連する非機能要件
-<!-- 関連するNFRへのリンク -->
+{/* 関連するNFRへのリンク */}
 - [NFR-001：パフォーマンス要件](../non-functional/nfr-001.mdx)
 
 ## 参考情報
-<!-- 追加の情報、図表、リンクなど -->
+{/* 追加の情報、図表、リンクなど */}
 
 export const changes = [
   {

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

@@ -8,14 +8,15 @@ urgency: 7
 importance: 8
 ---
 import { PriorityMatrix } from '@site/src/components/PriorityMatrix';
+// import { ChangeHistoryComponent } from '@site/src/components/ChangeHistory';
 
 <PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
 
-<!-- <div style={{ marginBottom: "1rem" }}>
+{/* <div style={{ marginBottom: "1rem" }}>
   {frontMatter.tags.map((tag) => (
     <Tag key={tag} name={tag} />
   ))}
-</div> -->
+</div> */}
 
 ## 概要
 システムへのアクセスを制御するためのユーザー認証機能を提供する。

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

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

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

@@ -13,23 +13,23 @@ import { ChangeHistoryComponent } from '@site/src/components/ChangeHistory';
 <PriorityMatrix urgency={frontMatter.urgency} importance={frontMatter.importance} />
 
 ## 概要
-<!-- 非機能要件の概要を記述 -->
+{/* 非機能要件の概要を記述 */}
 
 ## 詳細要件
 ### カテゴリ1
-<!-- 要件の詳細を記述 -->
+{/* 要件の詳細を記述 */}
 
 ### カテゴリ2
-<!-- 要件の詳細を記述 -->
+{/* 要件の詳細を記述 */}
 
 ## 測定方法
-<!-- 要件の達成を測定する方法を記述 -->
+{/* 要件の達成を測定する方法を記述 */}
 
 ## 制約条件
-<!-- 制約条件があれば記述 -->
+{/* 制約条件があれば記述 */}
 
 ## 関連する機能要件
-<!-- 関連する機能要件へのリンク -->
+{/* 関連する機能要件へのリンク */}
 
 export const changes = [
   {

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

@@ -11,4 +11,4 @@ import BusinessModel from '@site/static/img/business-model.drawio.svg';
 1. 参考
     1. https://drawio-app.com/blog/business-model-canvas/
     1. note: 『ビジネスの仕組みがわかる 図解のつくりかた』全文公開
-        1. https://note.com/bizgram/n/n3dbed12f95ea
+        1. https://note.com/bizgram/n/n3dbed12f95ea

package/templates/docs/03-external/index.mdx

@@ -2,7 +2,7 @@
 id: index
 sidebar_position: 1
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # 外部設計
 

package/templates/docs/04-internal/batches/import-products.mdx

@@ -4,7 +4,7 @@ tags:
   - batch
   - product
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # import-products - 商品取込
 ## 概要 {#overview}

package/templates/docs/04-internal/policies/claude.mdx

@@ -0,0 +1,91 @@
+---
+sidebar_position: 4
+tags:
+  - claude
+  - ai
+---
+
+# Claudeの使い方
+
+このプロジェクトでは[Claude Code](https://claude.ai/code)を使ってドキュメント作成を効率化しています。
+
+## スラッシュコマンド
+
+ドキュメントの新規作成はスラッシュコマンドで行います。
+ファイル作成と `index.mdx` への登録を自動で行います。
+
+### /new-table
+
+テーブル定義ドキュメントを新規作成します。
+
+```
+/new-table <physical_name> <logical_name> <schema> <description>
+```
+
+1. 作成先: `docs/04-internal/tables/{physical_name}.mdx`
+1. index登録: `docs/04-internal/tables/index.mdx`
+
+例
+
+```
+/new-table orders 注文 public 注文情報を管理するテーブル
+```
+
+### /new-screen
+
+画面定義ドキュメントを新規作成します。
+
+```
+/new-screen <physical_name> <logical_name>
+```
+
+1. 作成先: `docs/04-internal/screens/{physical_name}.mdx`
+1. index登録: `docs/04-internal/screens/index.mdx`
+
+例
+
+```
+/new-screen order-list 注文一覧
+```
+
+### /new-batch
+
+バッチ定義ドキュメントを新規作成します。
+
+```
+/new-batch <id> <logical_name>
+```
+
+1. 作成先: `docs/04-internal/batches/{id}.mdx`
+1. index登録: `docs/04-internal/batches/index.mdx`
+
+例
+
+```
+/new-batch import-orders 注文取込
+```
+
+## Claudeが参照するルール
+
+Claudeは `.claude/rules/` 配下のファイルを参照してドキュメントを作成します。
+各ルールの詳細は以下のドキュメントが権威ある情報源です。
+
+| ルールファイル | 参照先 |
+| -------------- | ------ |
+| `.claude/rules/markdown.md` | [Markdown](../rules/markdown.mdx) ※ルートのrulesを参照 |
+| `.claude/rules/git.md` | [ブランチ命名規約](./branch-naming-rules.mdx)、[PR運用フロー](./pull-request-operation-flow.mdx) |
+| `.claude/rules/database.md` | [データベース](../rules/database.mdx) |
+| `.claude/rules/document-creation.md` | [ドキュメント作成ルール](../rules/document-creation-rules.mdx) |
+| `.claude/rules/review.md` | [レビュープロセス](../rules/review-process.mdx) |
+
+## Claudeの操作範囲
+
+Claudeが自律的に行ってよい操作と禁止操作を明確にしています。
+
+| 操作 | 可否 |
+| ---- | :--: |
+| ファイルの作成・編集・削除 | :o: |
+| `git add`(ステージング) | :o: |
+| `git fetch`、`git checkout` | :o: |
+| `git commit` | :x: |
+| `git push` | :x: |

package/templates/docs/04-internal/policies/github.mdx

@@ -4,23 +4,21 @@ tags:
   - git
   - github
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # GitHubの利用方法
 
 ## 基本的なGitHubの利用ルール
 
 ### コミットメッセージのルール
-1. 簡潔で分かりやすいコミットメッセージを書く
-1. プレフィックスを使用する（例：`feat:`、`fix:`、`docs:`、`style:`、`refactor:`、`test:`、`chore:`）
-1. 現在形の動詞で始める（例：「Add」「Fix」「Update」など）
+1. 日本語で記述する
+1. 英語プレフィックス(`feat:`、`fix:`、`chore:` など)は使用しない
+1. 日本語の動詞で始める(「追加」「修正」「更新」「削除」「変更」)
 1. 50文字以内に収める
 
 ### ブランチ戦略
-1. `main`/`master`ブランチは常に安定した状態を保つ
-1. 機能開発は`feature/機能名`ブランチで行う
-1. バグ修正は`fix/バグ内容`ブランチで行う
-1. リリース準備は`release/バージョン番号`ブランチで行う
+1. ブランチ命名規則の詳細は[ブランチ命名規約](./branch-naming-rules.mdx)を参照
+1. `main` ブランチは常に安定した状態を保つ
 
 ### プルリクエスト(PR)のルール
 1. 明確なタイトルと説明を書く

package/templates/docs/04-internal/rules/database.mdx

@@ -3,7 +3,7 @@ sidebar_position: 5
 tags:
   - Database
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # データベース
 

package/templates/docs/04-internal/screens/common.mdx

@@ -0,0 +1,15 @@
+---
+sidebar_position: 5
+---
+import { TBD } from '@site/src/components/TBD';
+
+# 画面共通事項
+
+## エラー表示ポリシー {#error-display-policy}
+1. <TBD/>
+
+## ローディング表示 {#loading}
+1. <TBD/>
+
+## 共通UIパターン {#common-ui-patterns}
+1. <TBD/>

package/templates/docs/04-internal/screens/dashboard.mdx

@@ -1,11 +1,11 @@
 ---
 sidebar_position: 4
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # ダッシュボード
 ## ファイル
-<!-- 1. frontend/src/routes/[dashboard.svelte](../../../../frontend/src/routes/dashboard.svelte) -->
+{/* 1. frontend/src/routes/[dashboard.svelte](../../../../frontend/src/routes/dashboard.svelte) */}
 
 ## 概要
 1. <TBD/>

package/templates/docs/04-internal/screens/index.mdx

@@ -3,7 +3,7 @@ id: index
 sidebar_position: 1
 hide_table_of_contents: true
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # 画面定義
 ## 画面一覧

package/templates/docs/04-internal/screens/login.mdx

@@ -1,11 +1,11 @@
 ---
 sidebar_position: 2
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # ログイン
 ## ファイル
-<!-- 1. frontend/src/routes/[login.svelte](../../../../frontend/src/routes/login.svelte) -->
+{/* 1. frontend/src/routes/[login.svelte](../../../../frontend/src/routes/login.svelte) */}
 
 ## 概要
 1. ログイン画面

package/templates/docs/04-internal/screens/menu.mdx

@@ -1,11 +1,11 @@
 ---
 sidebar_position: 3
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # メニュー
 ## ファイル
-<!-- 1. frontend/src/routes/[menu.svelte](../../../../frontend/src/routes/menu.svelte) -->
+{/* 1. frontend/src/routes/[menu.svelte](../../../../frontend/src/routes/menu.svelte) */}
 
 ## 概要
 1. メニュー画面

package/templates/docs/index.tsx

@@ -1,3 +1,4 @@
+import Link from '@docusaurus/Link';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import Heading from '@theme/Heading';
 import Layout from '@theme/Layout';
@@ -29,7 +30,67 @@ function DocumentSection() {
         <p>
           このサイトは{siteConfig.title}
           の設計、仕様を管理するためのドキュメントサイトです。
+          <br />
+          システムの要件定義から詳細設計まで、プロジェクトに関する技術文書を体系的に管理しています。
         </p>
+
+        <div className="row">
+          <div className="col col--4">
+            <div className={styles.featureCard}>
+              <Heading as="h3">ドキュメント構成</Heading>
+              <ul>
+                <li>
+                  <Link to="/docs/overview">プロジェクト概要・分析</Link>
+                </li>
+                <li>
+                  <Link to="/docs/requirements">要件定義</Link>
+                </li>
+                <li>
+                  <Link to="/docs/external">外部設計</Link>
+                </li>
+                <li>
+                  <Link to="/docs/internal">内部設計</Link>
+                </li>
+              </ul>
+            </div>
+          </div>
+          <div className="col col--4">
+            <div className={styles.featureCard}>
+              <Heading as="h3">編集ガイド</Heading>
+              <ul>
+                <li>
+                  <Link to="/docs/internal/rules/markdown">Markdownの書き方</Link>
+                </li>
+                <li>
+                  <Link to="/docs/internal/rules/document-creation-rules">
+                    ドキュメント作成ルール
+                  </Link>
+                </li>
+                <li>
+                  <Link to="/docs/internal/rules/review-process">レビュープロセス</Link>
+                </li>
+              </ul>
+            </div>
+          </div>
+          <div className="col col--4">
+            <div className={styles.featureCard}>
+              <Heading as="h3">運用ポリシー</Heading>
+              <ul>
+                <li>
+                  <Link to="/docs/internal/policies/github">GitHubの利用方法</Link>
+                </li>
+                <li>
+                  <Link to="/docs/internal/policies/pull-request-operation-flow">
+                    pull request運用フロー
+                  </Link>
+                </li>
+                <li>
+                  <Link to="/docs/internal/policies/branch-naming-rules">branch命名規約</Link>
+                </li>
+              </ul>
+            </div>
+          </div>
+        </div>
       </div>
     </div>
   );

package/templates/docs/introduction/document-editing/how-to.mdx

@@ -23,9 +23,9 @@ tag:
     ```
 
 ## 階層表示したい場合 {#to-layerd}
-1. サブフォルダーを作成し、そこにファイル `_category_.yml` を作る
+1. サブフォルダーを作成し、そこにファイル `_category_.yaml` を作る
 1. 例
-    ```yml title="_category_.yml"
+    ```yml title="_category_.yaml"
     label: 'ドキュメント編集方法'
     position: 4
     ```

package/templates/docs/introduction/index.mdx

@@ -3,7 +3,7 @@ id: index
 sidebar_position: 1
 hide_title: true
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # Introduction
 

package/templates/docs/introduction/operational-policies/sharepoint.mdx

@@ -1,7 +1,7 @@
 ---
 sidebar_position: 2
 ---
-import TBD from '@site/src/components/TBD';
+import { TBD } from '@site/src/components/TBD';
 
 # SharePoint
 1. <TBD/> URLリンク

package/templates/package.json.template

@@ -15,26 +15,28 @@
     "typecheck": "tsc"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.9.2",
-    "@docusaurus/preset-classic": "^3.9.2"{{#hasMermaid}},
-    "@docusaurus/theme-mermaid": "^3.9.2"{{/hasMermaid}},
-    "@easyops-cn/docusaurus-search-local": "^0.52.2",
+    "@docusaurus/core": "3.10.1",
+    "@docusaurus/preset-classic": "3.10.1"{{#hasMermaid}},
+    "@docusaurus/theme-mermaid": "3.10.1"{{/hasMermaid}},
+    "@easyops-cn/docusaurus-search-local": "^0.55.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0"{{#hasPlantUML}},
-    "docusaurus-theme-plantuml": "^1.0.2"{{/hasPlantUML}},
+    "docusaurus-theme-plantuml": "^1.3.2"{{/hasPlantUML}},
+    "js-yaml": "^4.1.1",
     "prism-react-renderer": "^2.4.1",
     "react": "^19.0.0",
     "react-dom": "^19.0.0"{{#hasRedoc}},
     "redocusaurus": "^2.5.0"{{/hasRedoc}}
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^3.9.2",
-    "@docusaurus/tsconfig": "3.9.2",
-    "@docusaurus/types": "^3.9.2",
-    "@types/node": "^24.2.1",
+    "@biomejs/biome": "^2.4.15",
+    "@docusaurus/module-type-aliases": "3.10.1",
+    "@docusaurus/tsconfig": "3.10.1",
+    "@docusaurus/types": "3.10.1",
+    "@types/node": "^22.0.0",
     "@types/react": "^19.0.0",
     "@types/react-dom": "^19.0.0",
-    "typescript": "~5.9.2"
+    "typescript": "~6.0.3"
   },
   "browserslist": {
     "production": [">0.5%", "not dead", "not op_mini all"],

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

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

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

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