UNPKG

paqad-ai

Version:

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

github.com/Eliyce/paqad-ai

Eliyce/paqad-ai

54 lines (39 loc) • 2.21 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
54
--- name: ui-doc-maintainer description: 'Maintains UI screen, component and state docs. Use when UI behavior or structure changed and handoff has not closed, above all when new states, variants or screen roles appeared.' metadata: model_tier: medium cacheable: 'true' output_format: markdown paqad-meta: skill.meta.yaml --- ## What It Does Maintains the canonical UI docs for screens, components, and states so interface changes are documented as one coherent system rather than scattered notes. ## Use This When After UI behavior or structure changes and before handoff closes, especially when new states, variants, or screen responsibilities were introduced. ## Inputs - Read the affected `docs/modules/*/ui/*.md` files first. - Read the changed UI implementation and any current flow or state docs. - Read `references/ui-doc-fields.md` before editing canonical UI docs. ## Procedure 1. Run `scripts/find-ui-docs.sh` to enumerate canonical per-module UI docs. 2. Identify which docs are stale relative to the change. 3. For each new/changed component, fill `assets/component-entry.template.md` (Responsibility, Props, States, Variants, A11y, Used by): never partial. 4. Update screens, components, and states in one pass; reference shared patterns instead of duplicating prose. 5. Format report per `assets/output.template.md`; validate with `scripts/lint-output.sh`. ## Output Contract - Return sections named `Updated UI Docs` and `Open UI Gaps`. - List each changed doc file in backticks with the doc facet updated: screen, component, or state. - If all gaps are resolved, write `Open UI Gaps: none`. ## Escalate / Stop Conditions - Ask when the intended ownership of a screen or component is unclear from the request or code. - Warn when the interface has visible states that cannot be documented confidently from the available evidence. - Do not create placeholder component contracts without props, states, or usage context. ## Resources - `references/ui-doc-fields.md` - `scripts/find-ui-docs.sh` - `scripts/lint-output.sh` - `assets/output.template.md` - `assets/component-entry.template.md` - `runtime/capabilities/coding/checklists/edge-cases-coding.md` - `agents/openai.yaml`