UNPKG

paqad-ai

Version:

Spec-driven development framework — AI agents that think before they type

github.com/Eliyce/paqad-ai

Eliyce/paqad-ai

53 lines (38 loc) • 2.15 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
--- name: user-flow-generation description: 'Generates or updates user flows for UI-facing features. Use when a request changes a screen, component or major interaction path and the flow docs must describe the new journey.' metadata: model_tier: medium cacheable: 'true' output_format: markdown paqad-meta: skill.meta.yaml --- ## What It Does Generates or updates user flow documentation for UI-facing work so primary, alternate, and failure paths are explicit for design, engineering, QA, and docs maintenance. ## Use This When When the request changes a screen, component, or major interaction path and the canonical flow docs need to describe the resulting user journey clearly. ## Inputs - Read the request, current user-flow docs, and relevant UI docs first. - Read `references/user-flow-sections.md` before writing or revising a flow. - Read the current state inventory and heuristic notes if they exist. ## Procedure 1. Define Actor / Entry / Success up top per `assets/output.template.md`. 2. Write the Primary Flow as an ordered, user-observable list: defer implementation steps to technical docs. 3. Walk `assets/branch-categories.txt` (Empty, Loading, Error, Permission, Retry, Blocked); add a sub-flow only when the change touches that branch. 4. Keep names consistent with the glossary and screen docs. 5. Validate with `scripts/lint-output.sh`. ## Output Contract - Return sections named `Primary Flow`, `Alternate Paths`, and `Flow Gaps`. - List each flow step as an ordered item written from the user or system perspective. - If the flow is fully documented, write `Flow Gaps: none`. ## Escalate / Stop Conditions - Ask when the actor, entry point, or success condition is not defined clearly enough to map the journey. - Warn when the requested UI behavior conflicts with existing flow docs or state definitions. - Do not turn technical implementation steps into user-flow steps. ## Resources - `references/user-flow-sections.md` - `scripts/lint-output.sh` - `assets/output.template.md` - `assets/branch-categories.txt` - `runtime/capabilities/coding/checklists/edge-cases-coding.md` - `agents/openai.yaml`