diff --git a/README.md b/README.md index 3ef9304..6ef4915 100644 --- a/README.md +++ b/README.md @@ -6,30 +6,47 @@ Adaptable to any enterprise software project. Clone, start writing specs — dom ## Installation -1. **Clone the repository** +SpecForge is a **Claude Code plugin**. Install it once and it's available in every project. - ```bash - git clone https://github.com/nguyendlp/specforge.git - cd specforge - ``` +### Option 1: Install from GitHub (recommended) -2. **Open with Claude Code** +```bash +claude plugin add --git https://github.com/nguyendlp/specforge.git +``` + +This installs SpecForge globally. All skills, commands, and agents are immediately available in any Claude Code session. + +### Option 2: Install in a specific project + +```bash +cd your-project +claude plugin add --git https://github.com/nguyendlp/specforge.git --project +``` + +This installs SpecForge only for the current project (added to `.claude/plugins/`). - ```bash - claude - ``` +### Option 3: Clone and install locally - Claude automatically loads `CLAUDE.md` and discovers all skills, commands, and agents. +```bash +git clone https://github.com/nguyendlp/specforge.git +claude plugin add ./specforge +``` + +### Verify installation + +```bash +claude plugin list +``` -3. **Start working** — use slash commands or let skills auto-trigger: +You should see `specforge` in the output. Then start using it: - ``` - /new-spec usecase CreateOrder - /new-epic UC0001 - /check-traceability - ``` +``` +/new-spec usecase CreateOrder +/new-epic UC0001 +/check-traceability +``` -No dependencies to install. SpecForge is a pure markdown repository — templates, skills, and agents are all markdown files that Claude Code reads directly. +No dependencies to install. SpecForge is a pure markdown plugin — templates, skills, and agents are all markdown files that Claude Code reads directly. ## Deterministic Validation @@ -78,16 +95,17 @@ At any point, run `/check-traceability` to verify that every spec has a delivery ## What's Inside -### Templates (22 types) +### Templates (20 types) **Specification Layer** — what to build: | Category | Templates | |---|---| +| SRS Overview | Scope, glossary, constraints, use case groupings, data model, traceability (IEEE 830 document envelope) | | Functional Requirements | Object, Use Case, Screen, Business Rule, Interface, Decision Table | -| High-Level Requirements | Actor, Workflow, State Transition, Permission Matrix, ORD, Use Case Diagram, Traceability Matrix | +| High-Level Requirements | Actor, Workflow, State Transition, Permission Matrix | | Non-Functional Requirements | NFR (ISO 25010 quality model) | -| Input Management | Meeting Note, Change Request, Impact Analysis | +| Input Management | Meeting Note, Change Request, Impact Analysis, Phase Delta, Change Management Rules | **Delivery Layer** — when to ship: @@ -107,7 +125,7 @@ See [`templates/README.md`](templates/README.md) for the full guide on how the t Skills auto-activate based on context — no manual invocation needed. -### Commands (10 slash commands) +### Commands (13 slash commands) | Command | Purpose | |---|---| @@ -115,6 +133,9 @@ Skills auto-activate based on context — no manual invocation needed. | `/new-epic ` | Generate epic from use case with story suggestions | | `/new-story ` | Create story with spec traceability and derived ACs | | `/new-sprint ` | Create sprint plan from committed stories | +| `/new-release-plan ` | Create release plan from epics with timeline | +| `/backlog-refinement ` | Guided refinement session with gap analysis | +| `/review-spec ` | IEEE 830/ISO 29148 quality review with scored report | | `/meeting-note ` | Capture meeting with UR extraction | | `/check-traceability [scope]` | Scan for orphans, broken refs, coverage gaps | | `/phase-delta ` | Create incremental Phase 2+ change document |