/f5-design

description: Generate design documents and specifications (D1-D4)
argument-hint: <generate|validate|spec> <type> [module]

/f5-design - Unified Design & Specification Command

**Consolidated command** that replaces:

• `/f5-spec` → `/f5-design spec`

Manage and generate design documents (Basic Design 基本設計, Detail Design 詳細設計) and specifications (SRS, Use Cases, Business Rules).

ARGUMENTS

The user's request is: $ARGUMENTS

MODE DETECTION

| Pattern | Mode | Description | |---------|------|-------------| | `spec <action>` | SPEC | SRS, Use Cases, Business Rules (D1-D2) | | `<other>` (default) | DESIGN | Architecture, DB, API, Screens (D3-D4) |

---

⚠️ CRITICAL OUTPUT RULES

**KHÔNG ĐƯỢC tạo files ở `docs/`, `output/`, hoặc thư mục khác.**

**BẮT BUỘC tuân theo cấu trúc sau:**

Basic Design (D3)

| Command | Document Type | Output Path | |---------|--------------|-------------| | `generate architecture` | Architecture | `.f5/specs/basic-design/v{VERSION}/system-architecture.md` | | `generate tables` | Database (all) | `.f5/specs/basic-design/v{VERSION}/database/database-design.md` | | `generate table <name>` | Database (single) | `.f5/specs/basic-design/v{VERSION}/database/{table-name}.md` | | `generate api-list` | API (all) | `.f5/specs/basic-design/v{VERSION}/api/api-design.md` | | `generate api <endpoint>` | API (single) | `.f5/specs/basic-design/v{VERSION}/api/{METHOD}-{endpoint}.md` | | `generate screen-list` | Screens (all) | `.f5/specs/basic-design/v{VERSION}/screens/screen-list.md` | | `generate screen <name>` | Screens (single) | `.f5/specs/basic-design/v{VERSION}/screens/{screen-name}.md` | | `generate batch <name>` | Batch Specs | `.f5/specs/basic-design/v{VERSION}/batch/{batch-name}.md` | | `generate erd` | ERD Diagram | `.f5/specs/basic-design/v{VERSION}/diagrams/erd.md` |

Detail Design (D4)

| Command | Document Type | Output Path | |---------|--------------|-------------| | `generate screen-detail <name>` | Screen Details | `.f5/specs/detail-design/v{VERSION}/screens/{screen-name}.md` | | `generate api-detail <endpoint>` | API Details | `.f5/specs/detail-design/v{VERSION}/api/{endpoint}.md` | | `generate batch-detail <name>` | Batch Details | `.f5/specs/detail-design/v{VERSION}/batch/{batch-name}.md` | | `generate component <name>` | Component Specs | `.f5/specs/detail-design/v{VERSION}/components/{component}.md` |

Export

| Document Type | Output Path | |--------------|-------------| | Basic Design Export | `.f5/output/basic-design-v{VERSION}.{FORMAT}` | | Detail Design Export | `.f5/output/detail-design-v{VERSION}.{FORMAT}` |

**VERSION format:** `v1.0.0`, `v1.1.0`, `v2.0.0`

**Ví dụ paths đúng:**

.f5/specs/basic-design/v1.0.0/system-architecture.md ✅
.f5/specs/basic-design/v1.0.0/database/database-design.md ✅
.f5/specs/basic-design/v1.0.0/api/api-design.md ✅
.f5/specs/basic-design/v1.0.0/screens/screen-list.md ✅
.f5/specs/detail-design/v1.0.0/screens/login.md ✅

**Ví dụ paths SAI:**

docs/Database-Design-v1.0.md ❌
.f5/specs/basic-design/v1.0.0/screen-list.md ❌  (missing screens/ folder!)
.f5/specs/basic-design/v1.0.0/api-design.md ❌  (missing api/ folder!)
basic-design.md ❌

STEP 1: PARSE ACTION

| Action | Description | |--------|-------------| | `generate <type>` | Generate design document | | `validate` | Validate design completeness | | `trace` | Check traceability | | `export` | Export to different formats | | `status` | Show design status |

ACTION: GENERATE

Basic Design (基本設計) Documents

> ⚠️ **OUTPUT PATH REMINDER**: All files MUST be created in `.f5/specs/basic-design/v1.0.0/` > - Architecture: `.f5/specs/basic-design/v1.0.0/system-architecture.md` > - Database: `.f5/specs/basic-design/v1.0.0/database/` > - API: `.f5/specs/basic-design/v1.0.0/api/` > - Screens: `.f5/specs/basic-design/v1.0.0/screens/` > > **NEVER create files in `docs/` folder!**

System Architecture

/f5-design generate architecture [--type <type>]

Types: `system`, `network`, `deployment`, `security`

**Output:** `.f5/specs/basic-design/v{VERSION}/system-architecture.md`

Database Design

**Available Commands:**

/f5-design generate table <table-name>    # Single table definition
/f5-design generate tables                # ALL tables (comprehensive document)
/f5-design generate database              # Alias for 'tables'

**⚠️ MANDATORY OUTPUT PATHS:**

| Command | Output Path | |---------|-------------| | `generate table users` | `.f5/specs/basic-design/v1.0.0/database/users.md` | | `generate tables` | `.f5/specs/basic-design/v1.0.0/database/database-design.md` | | `generate database` | `.f5/specs/basic-design/v1.0.0/database/database-design.md` |

**✅ CORRECT paths:**

.f5/specs/basic-design/v1.0.0/database/database-design.md ✅
.f5/specs/basic-design/v1.0.0/database/users.md ✅
.f5/specs/basic-design/v1.0.0/database/orders.md ✅

**❌ WRONG paths (NEVER use):**

docs/Database-Design-v1.0.md ❌
.f5/specs/basic-design/v1.0.0/database-design.md ❌  (missing database/ folder!)
database.md ❌

**Template:**

# Table Definition: {{TABLE_NAME}}

## Overview
| Property | Value |
|----------|-------|
| Table Name | {{TABLE_NAME}} |
| Schema | {{SCHEMA}} |
| Related Requirements | {{REQ_IDS}} |

## Columns
| # | Column | Type | Nullable | Default | Description |
|---|--------|------|----------|---------|-------------|
| 1 | id | BIGINT | NO | AUTO | Primary key |

## Indexes
| Name | Columns | Type | Description |
|------|---------|------|-------------|

## Foreign Keys
| Name | Column | References | On Delete |
|------|--------|------------|-----------|

## DDL
\`\`\`sql
CREATE TABLE {{TABLE_NAME}} (
  ...
);
\`\`\`

API Design

**Available Commands:**

/f5-design generate api <endpoint>        # Single API endpoint
/f5-design generate api-list              # ALL APIs (comprehensive document)
/f5-design generate apis                  # Alias for 'api-list'

**⚠️ MANDATORY OUTPUT PATHS:**