UNPKG

paqad-ai

Version:

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

github.com/Eliyce/paqad-ai

Eliyce/paqad-ai

57 lines (42 loc) • 2.73 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
55
56
57
--- name: integration-doc-maintainer description: 'Maintains cross-module integration documentation. Use when a request affects published or consumed events, background jobs, external service contracts or any cross-module dependency.' metadata: model_tier: medium max_lines: '200' cacheable: 'false' output_format: markdown paqad-meta: skill.meta.yaml --- ## What It Does Maintains cross-module integration docs by documenting events, jobs, contracts, and fallback behavior for any change that crosses module or service boundaries. ## Use This When When a request affects published events, consumed events, background jobs, external service contracts, or any cross-module dependency. ## Inputs - Read the current integration docs first: `integration/events.md` and `integration/contracts.md` for the affected module. - Read the changed code and any generated event inventory or contract references. - Read `references/integration-contract-fields.md` before updating entries. ## Procedure 1. Run `scripts/find-integration-docs.sh` to enumerate canonical events/contracts/jobs/integration docs. 2. Run `scripts/extract-events.sh <changed-files...>` to surface candidate event names; LLM confirms each before writing. 3. Update each event entry using `assets/event.template.md` (publisher, subscribers, payload, async behavior, failure expectations, versioning). 4. Update contracts with owner, versioning, and fallback/degradation behavior. Document both sides of every cross-module coupling. 5. Format report per `assets/output.template.md` and validate with `scripts/lint-output.sh`. Missing fallback / undocumented coupling → `## Consistency Warnings`, never silent. ## Output Contract - Match `assets/output.template.md`: `## Updated Integration Docs` and `## Consistency Warnings`. - Every updated item must name the event, contract, job, or integration path and the canonical doc path changed. - Output must pass `scripts/lint-output.sh` (exit 0). - Missing fallback behavior, subscriber ownership, or compatibility policy belongs under `Consistency Warnings`, never as an invented completed entry. ## Escalate / Stop Conditions - Ask when subscriber ownership, contract versioning, or fallback policy is unclear. - Warn when a new integration path has no documented recovery or compatibility posture. - Do not invent event payloads or subscriber lists that are not evidenced by the code or project docs. ## Resources - `references/integration-contract-fields.md` - `scripts/find-integration-docs.sh` - `scripts/extract-events.sh` - `scripts/lint-output.sh` - `assets/output.template.md` - `assets/event.template.md` - `runtime/templates/runner-scripts/extract-events.sh.hbs` - `agents/openai.yaml`