Dev Docs

Internal process diagrams and references. Development only.

Help Documentation Update Process

How we keep help docs in sync with product changes each cycle.

flowchart TD
  A["/generate-changelog"] --> B["docs/changelogs/YYYY-MM-DD.md
  Role-based changelog
  (Coder, Client Admin, Manager, Staff Coder)"]

  B --> C["/update-help-docs
  (PLA-1492)"]

  C --> D{"For each role's changes,
  cross-reference against
  existing help docs"}

  D -->|Page exists| E["Read current app code
  + technical user flow
  + existing help doc"]

  D -->|New feature| F["Flag for creation
  (new help page needed)"]

  E --> G["Update help doc
  to reflect changes"]

  G --> H["Commit single file
  docs: update role/slug"]

  F --> I["Run /generate-help-doc
  for new page"]

  I --> H

  H --> J{"More affected
  pages?"}

  J -->|Yes| D
  J -->|No| K["Done - PR ready for review"]

Full Documentation Pipeline

End-to-end process for creating and maintaining help documentation.

flowchart LR
  subgraph Create["Initial Creation (one-time)"]
    A1["/identify-user-flows"] --> A2["/document-user-flow"]
    A2 --> A3["/generate-help-doc"]
    A3 --> A4["/generate-screenshots"]
  end

  subgraph Update["Ongoing Maintenance (each cycle)"]
    B1["/generate-changelog"] --> B2["/update-help-docs"]
    B2 --> B3["Re-run /generate-screenshots
    for changed pages"]
  end

  Create --> Update

Dev Docs

Help Documentation Update Process

Full Documentation Pipeline

Related Links