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.1 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: existing-doc-checker description: 'Inspects canonical docs and registries before new artifacts are written. Use when creating or rewriting docs, plans or implementation notes and the project may already hold a canonical source.' metadata: model_tier: medium cacheable: 'true' output_format: markdown paqad-meta: skill.meta.yaml --- ## What It Does Finds the canonical docs, registries, and previously generated artifacts that already describe the requested area so new work starts from the current documented truth. ## Use This When Before creating or rewriting docs, plans, or implementation notes whenever there is any chance the project already has a canonical source for the topic. ## Inputs - Read the request and identify affected modules, flows, registries, or interfaces. - Read `.paqad/indexes/registry-status.json` if present to discover generated surfaces quickly. - Read `references/doc-scan-order.md` before scanning the docs tree. ## Procedure 1. Walk surfaces in the order in `assets/scan-order.txt`: registries / module indexes first, then per-module support docs. 2. Pipe topic keywords into `scripts/scan-docs.sh <keyword> ...` to enumerate canonical doc hits. 3. Classify each hit as canonical, drifted, or missing based on freshness and stated ownership. 4. Format per `assets/output.template.md`; validate with `scripts/lint-output.sh`. ## Output Contract - Match `assets/output.template.md`: `## Canonical Files`, `## Potential Drift`, `## Missing Docs`. - File paths must be backticked relative repo paths. - Output must pass `scripts/lint-output.sh` (exit 0). ## Escalate / Stop Conditions - Ask when multiple docs conflict and the canonical owner is unclear. - Warn when requested behavior appears undocumented across a critical system boundary. - Do not mark a file canonical if it is clearly a scratch note or obsolete artifact. ## Resources - `references/doc-scan-order.md` - `scripts/scan-docs.sh` - `scripts/lint-output.sh` - `assets/output.template.md` - `assets/scan-order.txt` - `.paqad/indexes/registry-status.json` - `agents/openai.yaml`