feat: setup documents

Author: 薛華慶, james.hsueh

README.md

@@ -21,7 +21,7 @@ mkdir -p ~/.claude/workflows
 
 # Clone 這個工具
 cd ~/.claude/workflows
-git clone <your-repo-url> sdd-workflow
+git clone https://github.com/CodeMachine0121/GSI-Protocol.git sdd-workflow
 ```
 
 ### 步驟 2: 在任何專案中使用
@@ -49,7 +49,7 @@ Claude Code 會自動找到全域安裝的指令。
 cd ~/projects/my-new-project
 
 # Clone 工具到 .claude 目錄
-git clone <your-repo-url> .sdd-workflow
+git clone https://github.com/CodeMachine0121/GSI-Protocol.git .sdd-workflow
 
 # 複製 slash commands 到專案
 mkdir -p .claude/commands
@@ -60,7 +60,7 @@ cp .sdd-workflow/.claude/commands/* .claude/commands/
 
 ```bash
 # 選項 A: 作為 git submodule（推薦）
-git submodule add <your-repo-url> .sdd-workflow
+git submodule add https://github.com/CodeMachine0121/GSI-Protocol.git .sdd-workflow
 
 # 選項 B: 直接 commit
 git add .claude/
@@ -386,7 +386,7 @@ pwd
 
 # 1. 安裝
 cd ~/.claude/workflows
-git clone <repo> sdd-workflow
+git clone https://github.com/CodeMachine0121/GSI-Protocol.git sdd-workflow
 
 # 2. 進入專案
 cd ~/my-project

COMMANDS.md docs/COMMANDS.mdCOMMANDS.md renamed to docs/COMMANDS.md

@@ -0,0 +1,231 @@
+# GSI-Protocol Documentation
+
+Complete documentation for the GSI-Protocol (Gherkin-Structure-Implementation) workflow.
+
+---
+
+## 📚 Documentation Index
+
+### Getting Started
+
+| Document | Description | Time |
+|----------|-------------|------|
+| **[Quick Start Guide](QUICKSTART.md)** | 5-minute tutorial to get started | 5 min |
+| **[Installation Guide](INSTALL.md)** | Detailed installation instructions for all scenarios | 10 min |
+
+### Reference
+
+| Document | Description |
+|----------|-------------|
+| **[Commands Reference](COMMANDS.md)** | Complete documentation for all commands |
+| **[Language Guide](LANGUAGE_GUIDE.md)** | Multi-language support and examples |
+| **[Workflow Definition](expected_workflow.md)** | Detailed SDD methodology and philosophy |
+
+### Community
+
+| Document | Description |
+|----------|-------------|
+| **[Contributing Guidelines](../CONTRIBUTING.md)** | How to contribute to the project |
+| **[License](../LICENSE)** | MIT License details |
+
+---
+
+## 🚀 Recommended Reading Order
+
+### For First-Time Users
+
+1. **[Quick Start](QUICKSTART.md)** - Understand the basics
+2. **[Installation](INSTALL.md)** - Set up the tool
+3. Try it: `/sdd-auto Create a calculator in Python`
+4. **[Commands](COMMANDS.md)** - Learn all available commands
+
+### For Team Leads
+
+1. **[Workflow Definition](expected_workflow.md)** - Understand the methodology
+2. **[Language Guide](LANGUAGE_GUIDE.md)** - See language support
+3. **[Installation](INSTALL.md)** - Choose installation strategy
+4. **[Commands](COMMANDS.md)** - Plan team workflow
+
+### For Contributors
+
+1. **[Workflow Definition](expected_workflow.md)** - Understand core principles
+2. **[Contributing](../CONTRIBUTING.md)** - Learn contribution process
+3. **[Language Guide](LANGUAGE_GUIDE.md)** - Add language examples
+
+---
+
+## 📖 Documentation Overview
+
+### Quick Start Guide
+
+**File**: [QUICKSTART.md](QUICKSTART.md)
+
+Learn GSI-Protocol in 5 minutes:
+- Installation in 30 seconds
+- Your first feature in 2 minutes
+- Common usage patterns
+- Tips for success
+
+**Perfect for**: Developers who want to try it immediately
+
+---
+
+### Installation Guide
+
+**File**: [INSTALL.md](INSTALL.md)
+
+Complete installation documentation:
+- Global installation (recommended)
+- Project-specific installation
+- Team collaboration setup
+- Troubleshooting
+
+**Perfect for**: Understanding all installation options
+
+---
+
+### Commands Reference
+
+**File**: [COMMANDS.md](COMMANDS.md)
+
+Complete command documentation:
+- `/sdd-auto` - Auto workflow
+- `/sdd-spec` - Phase 1: Specification
+- `/sdd-arch` - Phase 2: Architecture
+- `/sdd-impl` - Phase 3: Implementation
+- `/sdd-verify` - Phase 4: Verification
+- Usage examples
+- Decision matrix
+- Best practices
+
+**Perfect for**: Daily reference and mastering the tool
+
+---
+
+### Language Guide
+
+**File**: [LANGUAGE_GUIDE.md](LANGUAGE_GUIDE.md)
+
+Multi-language support guide:
+- Language-specific patterns
+- Python, TypeScript, Go, Java, Rust, C# examples
+- Choosing the right language
+- Cross-language migration
+- Best practices by language
+
+**Perfect for**: Multi-language teams and language-specific questions
+
+---
+
+### Workflow Definition
+
+**File**: [expected_workflow.md](expected_workflow.md)
+
+Deep dive into the SDD methodology:
+- Philosophy and principles
+- 4-phase workflow details
+- PM, Architect, Engineer, QA roles
+- BDD and Gherkin usage
+- Quality assurance
+
+**Perfect for**: Understanding the "why" behind GSI-Protocol
+
+---
+
+## 🎯 Quick Links by Role
+
+### Product Manager
+- **[Workflow Definition](expected_workflow.md)** - Understand PM role in Phase 1
+- **[Commands](COMMANDS.md)** - `/sdd-spec` command details
+
+### System Architect
+- **[Workflow Definition](expected_workflow.md)** - Understand Architect role in Phase 2
+- **[Language Guide](LANGUAGE_GUIDE.md)** - Structure patterns by language
+- **[Commands](COMMANDS.md)** - `/sdd-arch` command details
+
+### Software Engineer
+- **[Quick Start](QUICKSTART.md)** - Get started quickly
+- **[Commands](COMMANDS.md)** - All commands reference
+- **[Language Guide](LANGUAGE_GUIDE.md)** - Implementation patterns
+
+### QA Engineer
+- **[Workflow Definition](expected_workflow.md)** - Understand QA role in Phase 4
+- **[Commands](COMMANDS.md)** - `/sdd-verify` command details
+
+### DevOps / Team Lead
+- **[Installation](INSTALL.md)** - Setup for teams
+- **[Workflow Definition](expected_workflow.md)** - Process overview
+
+---
+
+## 🔍 Finding Information
+
+### By Task
+
+**"I want to install the tool"**
+→ [Installation Guide](INSTALL.md)
+
+**"I want to try it quickly"**
+→ [Quick Start](QUICKSTART.md)
+
+**"I need to understand a specific command"**
+→ [Commands Reference](COMMANDS.md)
+
+**"I want to use it with Go/Rust/etc"**
+→ [Language Guide](LANGUAGE_GUIDE.md)
+
+**"I want to understand the methodology"**
+→ [Workflow Definition](expected_workflow.md)
+
+**"I want to contribute"**
+→ [Contributing Guidelines](../CONTRIBUTING.md)
+
+---
+
+### By Question
+
+**"How do I install this?"**
+→ [Installation Guide](INSTALL.md)
+
+**"What commands are available?"**
+→ [Commands Reference](COMMANDS.md)
+
+**"Does it work with TypeScript/Go/etc?"**
+→ [Language Guide](LANGUAGE_GUIDE.md)
+
+**"When should I use /sdd-auto vs manual phases?"**
+→ [Commands Reference](COMMANDS.md) - Decision Matrix
+
+**"How does the 4-phase workflow work?"**
+→ [Workflow Definition](expected_workflow.md)
+
+**"Can I use this in my team?"**
+→ [Installation Guide](INSTALL.md) - Team Setup
+
+---
+
+## 📞 Still Have Questions?
+
+- 💬 [GitHub Issues](https://github.com/CodeMachine0121/GSI-Protocol/issues)
+- 💡 [GitHub Discussions](https://github.com/CodeMachine0121/GSI-Protocol/discussions)
+- 📖 [Main README](../README.md)
+
+---
+
+## 🔄 Documentation Updates
+
+This documentation is continuously improved. If you find:
+- ❌ Errors or typos
+- 📝 Missing information
+- 💡 Suggestions for improvement
+
+Please:
+1. Open an issue
+2. Submit a pull request
+3. Start a discussion
+
+See [Contributing Guidelines](../CONTRIBUTING.md) for details.
+
+---
+
+**[⬆ Back to Main README](../README.md)**

docs/GETTING_STARTED.md

@@ -22,7 +22,7 @@ mkdir -p ~/.claude/workflows
 
 # 2. Clone 到全域目錄
 cd ~/.claude/workflows
-git clone <your-repo-url> sdd-workflow
+git clone https://github.com/CodeMachine0121/GSI-Protocol.git sdd-workflow
 
 # 3. 完成！現在在任何專案都能使用
 cd ~/your-project
@@ -59,7 +59,7 @@ cd ~/projects/my-python-api
 ```bash
 # 1. 在專案外臨時下載
 cd /tmp
-git clone <your-repo-url> sdd-temp
+git clone https://github.com/CodeMachine0121/GSI-Protocol.git sdd-temp
 
 # 2. 進入你的專案
 cd ~/your-project
@@ -76,24 +76,38 @@ git add .claude/commands/
 git commit -m "Add SDD workflow commands"
 ```
 
-### 使用腳本安裝（僅限 Public Repo）
+### 使用腳本安裝
 
-⚠️ **注意**: 如果 repo 是 private，curl/wget 會要求認證。請使用「手動複製」方式。
+#### 選項 A: 一鍵 curl 安裝（推薦，需要 Public Repo）
 
-如果 repo 是 public，可以使用安裝腳本：
+⚠️ **注意**: 此方式只在 repo 為 public 時可用
 
 ```bash
-# 先 clone repo
+# 下載並執行安裝腳本
+curl -sSL https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/install.sh | bash
+
+# 或使用 wget
+wget -qO- https://raw.githubusercontent.com/CodeMachine0121/GSI-Protocol/main/install.sh | bash
+```
+
+#### 選項 B: Clone 後安裝（Private Repo 也可用）
+
+```bash
+# 1. Clone repo（private repo 會要求 GitHub 認證）
 git clone https://github.com/CodeMachine0121/GSI-Protocol.git /tmp/gsi-temp
 cd /tmp/gsi-temp
 
-# 執行安裝腳本
+# 2. 執行安裝腳本
 ./install.sh
 
-# 清理
+# 3. 清理
 cd ~ && rm -rf /tmp/gsi-temp
 ```
 
+**如何選擇**：
+- ✅ Repo 是 **public** → 使用選項 A（最快最方便）
+- ✅ Repo 是 **private** → 使用選項 B 或「手動複製」方式
+
 ---
 
 ## 方法三：使用 Git Sparse Checkout（進階）
@@ -104,7 +118,7 @@ cd ~ && rm -rf /tmp/gsi-temp
 cd ~/your-project
 
 # 初始化 sparse checkout
-git clone --no-checkout <your-repo-url> .sdd-tools
+git clone --no-checkout https://github.com/CodeMachine0121/GSI-Protocol.git .sdd-tools
 cd .sdd-tools
 
 # 設定只 checkout .claude/commands
@@ -215,7 +229,7 @@ your-project/
 
 ```bash
 # 方式 1: 每個開發者自己全域安裝
-每人執行：mkdir -p ~/.claude/workflows && cd ~/.claude/workflows && git clone <repo>
+每人執行：mkdir -p ~/.claude/workflows && cd ~/.claude/workflows && git clone https://github.com/CodeMachine0121/GSI-Protocol.git
 
 # 方式 2: 專案內只包含 commands（Git 管理）
 在專案內：mkdir -p .claude/commands && cp <commands>
@@ -311,10 +325,10 @@ cd ~/.claude/workflows/sdd-workflow/examples
 
 ```bash
 # 全域安裝（推薦）
-mkdir -p ~/.claude/workflows && cd ~/.claude/workflows && git clone <repo> sdd-workflow
+mkdir -p ~/.claude/workflows && cd ~/.claude/workflows && git clone https://github.com/CodeMachine0121/GSI-Protocol.git sdd-workflow
 
 # 專案內安裝（只複製 commands）
-mkdir -p .claude/commands && cd /tmp && git clone <repo> sdd-temp && cp sdd-temp/.claude/commands/* <your-project>/.claude/commands/ && rm -rf sdd-temp
+mkdir -p .claude/commands && cd /tmp && git clone https://github.com/CodeMachine0121/GSI-Protocol.git sdd-temp && cp sdd-temp/.claude/commands/* <your-project>/.claude/commands/ && rm -rf sdd-temp
 ```
 
 開始使用 SDD Workflow，讓 AI 幫你寫結構化的程式碼！🚀