Flow - Process Flow Documentation

Name: flow
Rating: 76
Author: goffity

Document workflows, sequences, and state machines with Mermaid diagrams.

Usage

code

/flow [name]
/flow pr-review
/flow deployment

Output: $PROJECT_ROOT/docs/flows/[name].md

Instructions

•Parse name → kebab-case filename
•
Ask user about the flow:
- •What type? (process/sequence/state)
- •What actors/components are involved?
- •What are the main steps?
•Generate flow document with Mermaid diagram
•Save to docs/flows/[name].md

Template

markdown

# [Flow Name]

| Field | Value |
|-------|-------|
| Type | Process / Sequence / State |
| Actors | [list of actors] |
| Created | YYYY-MM-DD |

## Overview

> One sentence description of what this flow does.

## Diagram

```mermaid
sequenceDiagram
    participant A as Actor1
    participant B as Actor2

    A->>B: Action
    B-->>A: Response

Steps

•Step 1: Description
•Step 2: Description
•Step 3: Description

Error Handling

Error	Handling
[error case]	[how to handle]

•[related flows or docs]

code


## Diagram Types

### Sequence Diagram
```mermaid
sequenceDiagram
    participant U as User
    participant S as System
    U->>S: Request
    S-->>U: Response

Flowchart

mermaid

flowchart TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Action]
    B -->|No| D[Other]

State Diagram

mermaid

stateDiagram-v2
    [*] --> Idle
    Idle --> Processing: start
    Processing --> Done: complete
    Processing --> Error: fail

Related Commands

Command	Purpose
`/mem`	Capture insights about flows
`/flow`	Document flows (you are here)
`/pattern`	Document reusable patterns