aidp 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +21 -0
- data/README.md +210 -0
- data/bin/aidp +5 -0
- data/lib/aidp/analyze/agent_personas.rb +71 -0
- data/lib/aidp/analyze/agent_tool_executor.rb +445 -0
- data/lib/aidp/analyze/data_retention_manager.rb +426 -0
- data/lib/aidp/analyze/database.rb +243 -0
- data/lib/aidp/analyze/dependencies.rb +335 -0
- data/lib/aidp/analyze/error_handler.rb +486 -0
- data/lib/aidp/analyze/export_manager.rb +425 -0
- data/lib/aidp/analyze/feature_analyzer.rb +397 -0
- data/lib/aidp/analyze/focus_guidance.rb +517 -0
- data/lib/aidp/analyze/incremental_analyzer.rb +543 -0
- data/lib/aidp/analyze/language_analysis_strategies.rb +897 -0
- data/lib/aidp/analyze/large_analysis_progress.rb +504 -0
- data/lib/aidp/analyze/memory_manager.rb +365 -0
- data/lib/aidp/analyze/parallel_processor.rb +460 -0
- data/lib/aidp/analyze/performance_optimizer.rb +694 -0
- data/lib/aidp/analyze/prioritizer.rb +402 -0
- data/lib/aidp/analyze/progress.rb +75 -0
- data/lib/aidp/analyze/progress_visualizer.rb +320 -0
- data/lib/aidp/analyze/report_generator.rb +582 -0
- data/lib/aidp/analyze/repository_chunker.rb +702 -0
- data/lib/aidp/analyze/ruby_maat_integration.rb +572 -0
- data/lib/aidp/analyze/runner.rb +245 -0
- data/lib/aidp/analyze/static_analysis_detector.rb +577 -0
- data/lib/aidp/analyze/steps.rb +53 -0
- data/lib/aidp/analyze/storage.rb +600 -0
- data/lib/aidp/analyze/tool_configuration.rb +456 -0
- data/lib/aidp/analyze/tool_modernization.rb +750 -0
- data/lib/aidp/execute/progress.rb +76 -0
- data/lib/aidp/execute/runner.rb +135 -0
- data/lib/aidp/execute/steps.rb +113 -0
- data/lib/aidp/shared/cli.rb +117 -0
- data/lib/aidp/shared/config.rb +35 -0
- data/lib/aidp/shared/project_detector.rb +119 -0
- data/lib/aidp/shared/providers/anthropic.rb +26 -0
- data/lib/aidp/shared/providers/base.rb +17 -0
- data/lib/aidp/shared/providers/cursor.rb +102 -0
- data/lib/aidp/shared/providers/gemini.rb +26 -0
- data/lib/aidp/shared/providers/macos_ui.rb +26 -0
- data/lib/aidp/shared/sync.rb +15 -0
- data/lib/aidp/shared/util.rb +41 -0
- data/lib/aidp/shared/version.rb +7 -0
- data/lib/aidp/shared/workspace.rb +21 -0
- data/lib/aidp.rb +53 -0
- data/templates/ANALYZE/01_REPOSITORY_ANALYSIS.md +100 -0
- data/templates/ANALYZE/02_ARCHITECTURE_ANALYSIS.md +151 -0
- data/templates/ANALYZE/03_TEST_ANALYSIS.md +182 -0
- data/templates/ANALYZE/04_FUNCTIONALITY_ANALYSIS.md +200 -0
- data/templates/ANALYZE/05_DOCUMENTATION_ANALYSIS.md +202 -0
- data/templates/ANALYZE/06_STATIC_ANALYSIS.md +233 -0
- data/templates/ANALYZE/07_REFACTORING_RECOMMENDATIONS.md +316 -0
- data/templates/COMMON/AGENT_BASE.md +129 -0
- data/templates/COMMON/CONVENTIONS.md +19 -0
- data/templates/COMMON/TEMPLATES/ADR_TEMPLATE.md +21 -0
- data/templates/COMMON/TEMPLATES/DOMAIN_CHARTER.md +27 -0
- data/templates/COMMON/TEMPLATES/EVENT_EXAMPLE.yaml +16 -0
- data/templates/COMMON/TEMPLATES/MERMAID_C4.md +46 -0
- data/templates/COMMON/TEMPLATES/OPENAPI_STUB.yaml +11 -0
- data/templates/EXECUTE/00_PRD.md +36 -0
- data/templates/EXECUTE/01_NFRS.md +27 -0
- data/templates/EXECUTE/02A_ARCH_GATE_QUESTIONS.md +13 -0
- data/templates/EXECUTE/02_ARCHITECTURE.md +42 -0
- data/templates/EXECUTE/03_ADR_FACTORY.md +22 -0
- data/templates/EXECUTE/04_DOMAIN_DECOMPOSITION.md +24 -0
- data/templates/EXECUTE/05_CONTRACTS.md +27 -0
- data/templates/EXECUTE/06_THREAT_MODEL.md +23 -0
- data/templates/EXECUTE/07_TEST_PLAN.md +24 -0
- data/templates/EXECUTE/08_TASKS.md +29 -0
- data/templates/EXECUTE/09_SCAFFOLDING_DEVEX.md +25 -0
- data/templates/EXECUTE/10_IMPLEMENTATION_AGENT.md +30 -0
- data/templates/EXECUTE/11_STATIC_ANALYSIS.md +22 -0
- data/templates/EXECUTE/12_OBSERVABILITY_SLOS.md +21 -0
- data/templates/EXECUTE/13_DELIVERY_ROLLOUT.md +21 -0
- data/templates/EXECUTE/14_DOCS_PORTAL.md +23 -0
- data/templates/EXECUTE/15_POST_RELEASE.md +25 -0
- metadata +301 -0
@@ -0,0 +1,21 @@
|
|
1
|
+
# ADR NNN: [Decision Title]
|
2
|
+
|
3
|
+
Date: 2025-08-13
|
4
|
+
Status: Proposed | Accepted | Superseded by NNN
|
5
|
+
|
6
|
+
## Context
|
7
|
+
|
8
|
+
- Forces, constraints, goals, NFRs, tradeoffs.
|
9
|
+
|
10
|
+
## Decision
|
11
|
+
|
12
|
+
- What we're choosing and why (tie directly to PRD/NFRs/Architecture).
|
13
|
+
|
14
|
+
## Consequences
|
15
|
+
|
16
|
+
- Positive/negative outcomes; risks; follow-ups; observability hooks;
|
17
|
+
cost/security implications.
|
18
|
+
|
19
|
+
## Alternatives
|
20
|
+
|
21
|
+
- Options considered; why not chosen; re-evaluation trigger(s).
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# [Domain] Charter
|
2
|
+
|
3
|
+
## Responsibilities (In-Scope)
|
4
|
+
|
5
|
+
- Core domain capabilities owned by this bounded context.
|
6
|
+
|
7
|
+
## Out of Scope
|
8
|
+
|
9
|
+
- Clear exclusions to prevent scope creep.
|
10
|
+
|
11
|
+
## Inputs & Outputs
|
12
|
+
|
13
|
+
- APIs consumed/exposed (refs to contracts)
|
14
|
+
- Events published/subscribed (refs to contracts)
|
15
|
+
- Data ownership: authoritative stores and read models
|
16
|
+
|
17
|
+
## Interfaces & Anti-Corruption
|
18
|
+
|
19
|
+
- How external models are translated; adapters/ACLs; integration style (sync/async)
|
20
|
+
|
21
|
+
## Quality Attributes Emphasis
|
22
|
+
|
23
|
+
- Latency budgets, availability target, privacy/security, cost, operability
|
24
|
+
|
25
|
+
## Review & Ownership
|
26
|
+
|
27
|
+
- Reviewers, ownership rules, and escalation
|
@@ -0,0 +1,16 @@
|
|
1
|
+
# Example event contract (YAML)
|
2
|
+
name: product.catalog.v1.ProductCreated
|
3
|
+
version: v1
|
4
|
+
schema:
|
5
|
+
id: string
|
6
|
+
name: string
|
7
|
+
price: number
|
8
|
+
currency: string
|
9
|
+
metadata:
|
10
|
+
retention: 365d
|
11
|
+
pii: false
|
12
|
+
compatibility:
|
13
|
+
strategy: backward-compatible
|
14
|
+
rules:
|
15
|
+
- fields are only added with defaults
|
16
|
+
- never change semantics of existing fields
|
@@ -0,0 +1,46 @@
|
|
1
|
+
# Mermaid C4 Diagram Template
|
2
|
+
|
3
|
+
```mermaid
|
4
|
+
flowchart LR
|
5
|
+
subgraph Users
|
6
|
+
U[Primary User]
|
7
|
+
end
|
8
|
+
|
9
|
+
subgraph Edge
|
10
|
+
FE[Client/UI]
|
11
|
+
API[API Gateway]
|
12
|
+
end
|
13
|
+
|
14
|
+
subgraph Services
|
15
|
+
Auth[Auth]
|
16
|
+
Profile[Profile]
|
17
|
+
Orders[Orders]
|
18
|
+
subgraph Catalog
|
19
|
+
Cat[Catalog]
|
20
|
+
Search[Search]
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
subgraph Data
|
25
|
+
UDB[(User DB)]
|
26
|
+
ODB[(Orders DB)]
|
27
|
+
IDX[(Search Index)]
|
28
|
+
CACHE[(Cache)]
|
29
|
+
BUS[[Event Bus]]
|
30
|
+
end
|
31
|
+
|
32
|
+
U --> FE --> API
|
33
|
+
API --> Auth
|
34
|
+
API --> Profile
|
35
|
+
API --> Orders
|
36
|
+
API --> Cat
|
37
|
+
API --> Search
|
38
|
+
|
39
|
+
Profile --> UDB
|
40
|
+
Orders --> ODB
|
41
|
+
Search --> IDX
|
42
|
+
Cat --> CACHE
|
43
|
+
|
44
|
+
Auth -- publishes --> BUS
|
45
|
+
Orders -- subscribes --> BUS
|
46
|
+
```
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# AI Scaffold Product Requirements Document (PRD) Generator
|
2
|
+
|
3
|
+
You are a product strategist. Produce a **concise, complete PRD**.
|
4
|
+
|
5
|
+
## Important Instructions
|
6
|
+
|
7
|
+
- If you need additional information to create a complete PRD, create a file called `PRD_QUESTIONS.md` with specific questions for the user.
|
8
|
+
- If `PRD_QUESTIONS.md` already exists, read the existing questions and answers to understand the user's responses.
|
9
|
+
- Otherwise, proceed to create the complete PRD document.
|
10
|
+
- Only ask for clarifications at this PRD step. For subsequent steps, proceed with available information.
|
11
|
+
|
12
|
+
## Input
|
13
|
+
|
14
|
+
- A high-level prompt/idea provided by the user.
|
15
|
+
|
16
|
+
## Process
|
17
|
+
|
18
|
+
- Derive goals, scope, success metrics, personas, user stories (Given/When/Then),
|
19
|
+
constraints, risks, and out-of-scope.
|
20
|
+
- Keep it implementation-agnostic; do not pick frameworks/languages yet.
|
21
|
+
- Prefer measurable outcomes and acceptance criteria mapped to user stories.
|
22
|
+
|
23
|
+
## Output (Markdown → write to docs/PRD.md)
|
24
|
+
|
25
|
+
- Goal & Non-Goals
|
26
|
+
- Personas & Primary Use Cases
|
27
|
+
- User Stories (Given/When/Then)
|
28
|
+
- Constraints & Assumptions
|
29
|
+
- Success Metrics (leading/lagging)
|
30
|
+
- Out of Scope
|
31
|
+
- Risks & Mitigations
|
32
|
+
- Open Questions (for the PRD gate)
|
33
|
+
|
34
|
+
## Regeneration Policy
|
35
|
+
|
36
|
+
If re-run, append under `## Regenerated on <date>` rather than overwrite user edits.
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# AI Scaffold Non-Functional Requirements (NFRs) Generator
|
2
|
+
|
3
|
+
You are a systems/product engineer focusing on **quality attributes** that shape
|
4
|
+
architecture.
|
5
|
+
|
6
|
+
## Inputs
|
7
|
+
|
8
|
+
- `docs/PRD.md`
|
9
|
+
|
10
|
+
## Process
|
11
|
+
|
12
|
+
- Distill NFRs: availability, latency budgets, throughput, durability, security,
|
13
|
+
privacy, compliance, accessibility, observability, maintainability, portability,
|
14
|
+
cost.
|
15
|
+
- Convert ambiguous statements into specific, testable targets (e.g.,
|
16
|
+
"p95 < 300ms @ 100 RPS").
|
17
|
+
|
18
|
+
## Output (Markdown → write to docs/NFRs.md)
|
19
|
+
|
20
|
+
- Quality Attributes & Measurable Targets
|
21
|
+
- Constraints derived from NFRs
|
22
|
+
- Key Tradeoffs & Risks
|
23
|
+
- Validation Approach (how we'll test each NFR)
|
24
|
+
|
25
|
+
## Regeneration Policy
|
26
|
+
|
27
|
+
Append under `## Regenerated on <date>` if re-run.
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Architecture Gate — Questions to Ask (Only at this step)
|
2
|
+
|
3
|
+
Ask concisely; collect answers and append them under **Design Inputs** in
|
4
|
+
`Architecture.md`.
|
5
|
+
|
6
|
+
1. Target stack preferences (languages, frameworks, package managers)?
|
7
|
+
2. Deployment model (k8s/serverless/VMs); cloud/provider; primary data stores &
|
8
|
+
search choices?
|
9
|
+
3. Scale & SLOs (expected RPS, p95 latency, availability, cost ceilings)?
|
10
|
+
4. Data sensitivity/compliance (e.g., PII, HIPAA/PCI/GDPR/CCPA)?
|
11
|
+
5. Repo strategy (mono-repo vs multi-repo; separate contracts repo)?
|
12
|
+
6. Agent runtime (model(s), vector store, allowed tools, code execution limits)?
|
13
|
+
7. Human review points (which gates require human approval vs auto-merge on green)?
|
@@ -0,0 +1,42 @@
|
|
1
|
+
# AI Scaffold Architecture Generator
|
2
|
+
|
3
|
+
You are a software architect. Propose an architecture with **clean bounded contexts**
|
4
|
+
and **hexagonal structure**.
|
5
|
+
|
6
|
+
## Important Instructions
|
7
|
+
|
8
|
+
- If you need additional information to create a complete architecture, create a file called `ARCH_QUESTIONS.md` with specific questions for the user (see `02A_ARCH_GATE_QUESTIONS.md` for suggested questions).
|
9
|
+
- If `ARCH_QUESTIONS.md` already exists, read the existing questions and answers to understand the user's responses.
|
10
|
+
- Otherwise, proceed to create the complete architecture document.
|
11
|
+
- Only ask for clarifications at this Architecture step. For subsequent steps, proceed with available information.
|
12
|
+
|
13
|
+
## Inputs
|
14
|
+
|
15
|
+
- `docs/PRD.md`
|
16
|
+
- `docs/NFRs.md`
|
17
|
+
|
18
|
+
## Process
|
19
|
+
|
20
|
+
- Analyze domain to identify bounded contexts; choose integration styles
|
21
|
+
(sync/async, events, queues).
|
22
|
+
- Design **Context → Container → Component** (C4-ish) and produce a **Mermaid**
|
23
|
+
diagram.
|
24
|
+
- Ensure domain separation with anti-corruption layers.
|
25
|
+
- Suggest **3-5 ADRs** that capture key decisions to formalize next.
|
26
|
+
|
27
|
+
## Output (to disk)
|
28
|
+
|
29
|
+
1. `docs/Architecture.md` including:
|
30
|
+
- Context, Container, Component overviews
|
31
|
+
- Domain boundaries and ownership
|
32
|
+
- Integration points and data flow
|
33
|
+
- Design Inputs (answers to architecture gate questions)
|
34
|
+
- Architecture risks and mitigations
|
35
|
+
2. `docs/architecture.mmd` containing a Mermaid diagram (see
|
36
|
+
`COMMON/TEMPLATES/MERMAID_C4.md` for style).
|
37
|
+
3. `docs/adr/` suggestions list in `Architecture.md` under **Decisions to
|
38
|
+
Formalize (ADRs)**.
|
39
|
+
|
40
|
+
## Regeneration Policy
|
41
|
+
|
42
|
+
Append under `## Regenerated on <date>` if re-run.
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# AI Scaffold Architecture Decision Records (ADRs) Factory
|
2
|
+
|
3
|
+
You are the ADR scribe. For each proposed decision, create an ADR using the standard
|
4
|
+
format.
|
5
|
+
|
6
|
+
## Inputs
|
7
|
+
|
8
|
+
- `docs/Architecture.md` (the **Decisions to Formalize (ADRs)** list)
|
9
|
+
- `COMMON/TEMPLATES/ADR_TEMPLATE.md`
|
10
|
+
|
11
|
+
## Process
|
12
|
+
|
13
|
+
- One ADR per decision; assign sequential numbers (starting at 001). Keep
|
14
|
+
**Proposed** unless approved.
|
15
|
+
|
16
|
+
## Output (files in `docs/adr/`)
|
17
|
+
|
18
|
+
- `docs/adr/NNN-<slug>.md` using the template, including date `2025-08-13`
|
19
|
+
|
20
|
+
## Regeneration Policy
|
21
|
+
|
22
|
+
- Do not overwrite accepted ADRs. Create a new ADR that **supersedes** if needed.
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# AI Scaffold Domain Decomposition
|
2
|
+
|
3
|
+
You are a domain modeler. Define bounded contexts and their charters.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/PRD.md`, `docs/NFRs.md`, `docs/Architecture.md`
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Identify domains/contexts. For each, write a **Domain Charter** using
|
12
|
+
`COMMON/TEMPLATES/DOMAIN_CHARTER.md`.
|
13
|
+
- Include cross-cutting contexts (Security/Privacy, Data/Schema, Test, Docs,
|
14
|
+
SRE/Observability).
|
15
|
+
|
16
|
+
## Output
|
17
|
+
|
18
|
+
- `docs/DomainCharters/<Context>.md` per context
|
19
|
+
- Update `docs/Architecture.md` with a table mapping contexts → ownership →
|
20
|
+
interfaces.
|
21
|
+
|
22
|
+
## Regeneration Policy
|
23
|
+
|
24
|
+
Append new/changed contexts; keep previous charters.
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# AI Scaffold Contracts Generator
|
2
|
+
|
3
|
+
You are a contracts-first engineer.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/DomainCharters/*`
|
8
|
+
- `docs/Architecture.md`
|
9
|
+
|
10
|
+
## Process
|
11
|
+
|
12
|
+
- Define **API contracts** (OpenAPI/GraphQL), **event contracts** (YAML), and
|
13
|
+
**schemas/migrations**.
|
14
|
+
- Document versioning, compatibility rules, deprecation policy, and
|
15
|
+
consumer-driven tests.
|
16
|
+
|
17
|
+
## Output
|
18
|
+
|
19
|
+
- `contracts/api/*.yaml|.graphql`
|
20
|
+
- `contracts/events/*.yaml`
|
21
|
+
- `contracts/schema/*`
|
22
|
+
- A `contracts/README.md` explaining versioning and compatibility guarantees.
|
23
|
+
|
24
|
+
## Regeneration Policy
|
25
|
+
|
26
|
+
Maintain backward compatibility and version bump rules. Never silently break
|
27
|
+
consumers.
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# AI Scaffold Threat Model Generator
|
2
|
+
|
3
|
+
You are a security & privacy engineer.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/PRD.md`, `docs/NFRs.md`, `docs/Architecture.md`, `contracts/*`
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Perform **STRIDE** (threats) and **LINDDUN** (privacy) passes.
|
12
|
+
- Create a **data classification** and **PII flow** with retention policies and
|
13
|
+
DPAs where appropriate.
|
14
|
+
- Identify mitigations and owners.
|
15
|
+
|
16
|
+
## Output
|
17
|
+
|
18
|
+
- `docs/ThreatModel.md`
|
19
|
+
- `docs/DataMap.md` (classification, flows, retention)
|
20
|
+
|
21
|
+
## Regeneration Policy
|
22
|
+
|
23
|
+
Track risks with IDs; updates append notes and status changes.
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# AI Scaffold Test Plan Generator
|
2
|
+
|
3
|
+
You are a test strategist.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/PRD.md`, `docs/NFRs.md`, `contracts/*`, `docs/Architecture.md`
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Derive acceptance tests from user stories.
|
12
|
+
- Define the **test pyramid** (unit, contract, component, e2e) and
|
13
|
+
**property-based** tests for core logic.
|
14
|
+
- Establish coverage & mutation-testing thresholds.
|
15
|
+
- Follow Sandi Metz's rules for unit testing.
|
16
|
+
|
17
|
+
## Output
|
18
|
+
|
19
|
+
- `docs/TestPlan.md`
|
20
|
+
- `golden/` fixtures directory plan
|
21
|
+
|
22
|
+
## Regeneration Policy
|
23
|
+
|
24
|
+
Append; do not remove prior test cases unless superseded and noted.
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# AI Scaffold Task Planner
|
2
|
+
|
3
|
+
You are a planner.
|
4
|
+
|
5
|
+
## Important Instructions
|
6
|
+
|
7
|
+
- If you need additional information to create a complete task plan, create a file called `TASKS_QUESTIONS.md` with specific questions for the user.
|
8
|
+
- If `TASKS_QUESTIONS.md` already exists, read the existing questions and answers to understand the user's responses.
|
9
|
+
- Otherwise, proceed to create the complete task plan.
|
10
|
+
- Only ask for clarifications at this Tasks step. For subsequent steps, proceed with available information.
|
11
|
+
|
12
|
+
## Inputs
|
13
|
+
|
14
|
+
- `docs/DomainCharters/*`, `contracts/*`, `docs/TestPlan.md`
|
15
|
+
|
16
|
+
## Process
|
17
|
+
|
18
|
+
- Break work into tasks **per domain** and **per cross-cutting** area.
|
19
|
+
- Include Definition of Done (DoD), dependencies, and reviewer role.
|
20
|
+
|
21
|
+
## Output
|
22
|
+
|
23
|
+
- `tasks/domains/<context>.yaml`
|
24
|
+
- `tasks/crosscutting/<area>.yaml`
|
25
|
+
- `tasks/backlog.yaml` as a merge of all tasks with ordering hints
|
26
|
+
|
27
|
+
## Regeneration Policy
|
28
|
+
|
29
|
+
Append new tasks; mark deprecated tasks with status.
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# AI Scaffold DevEx Generator
|
2
|
+
|
3
|
+
You are a developer experience engineer.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/DomainCharters/*`, `contracts/*`
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Propose **language-agnostic** repository layouts for each context (service/lib)
|
12
|
+
using ports/adapters.
|
13
|
+
- Provide local dev environment hints (docker-compose/devcontainer) without
|
14
|
+
choosing specific stacks unless already decided via ADRs.
|
15
|
+
- Add lint/format/type-check suggestions generically (e.g., "use the
|
16
|
+
ecosystem-standard tools for chosen language").
|
17
|
+
|
18
|
+
## Output
|
19
|
+
|
20
|
+
- `docs/ScaffoldingGuide.md` with practical structures and examples for multiple
|
21
|
+
common stacks (JS/TS, Ruby on Rails, Go, Java, etc.)
|
22
|
+
|
23
|
+
## Regeneration Policy
|
24
|
+
|
25
|
+
Keep alternatives side-by-side; tie recommendations to ADRs when present.
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# AI Scaffold Implementation Guide Generator
|
2
|
+
|
3
|
+
You are a senior engineer writing **implementation guidance** for domain agents.
|
4
|
+
|
5
|
+
## Important Instructions
|
6
|
+
|
7
|
+
- If you need additional information to create a complete implementation guide, create a file called `IMPL_QUESTIONS.md` with specific questions for the user.
|
8
|
+
- If `IMPL_QUESTIONS.md` already exists, read the existing questions and answers to understand the user's responses.
|
9
|
+
- Otherwise, proceed to create the complete implementation guide.
|
10
|
+
- Only ask for clarifications at this Implementation step. For subsequent steps, proceed with available information.
|
11
|
+
|
12
|
+
## Inputs
|
13
|
+
|
14
|
+
- `contracts/*`, `docs/DomainCharters/*`, `docs/TestPlan.md`
|
15
|
+
|
16
|
+
## Process
|
17
|
+
|
18
|
+
- For each task, suggest patterns and structure using **SOLID**, **GoF**, **DDD**,
|
19
|
+
and **hexagonal architecture**.
|
20
|
+
- Emphasize **composition-first**, domain events, and clean interfaces.
|
21
|
+
- Require "Design by Contract" (pre/postconditions) for public functions where
|
22
|
+
idiomatic.
|
23
|
+
|
24
|
+
## Output
|
25
|
+
|
26
|
+
- `docs/ImplementationGuide.md` with examples and a pattern-to-use-case matrix.
|
27
|
+
|
28
|
+
## Regeneration Policy
|
29
|
+
|
30
|
+
Append new examples; keep prior guidance.
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# AI Scaffold Static Analysis Generator
|
2
|
+
|
3
|
+
You are a security/compliance engineer.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- Repository source as it evolves.
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Specify linters/formatters/type-checkers per language family.
|
12
|
+
- Add SAST, dependency risk scanning, license compliance, SBOM generation, secret
|
13
|
+
scanning.
|
14
|
+
|
15
|
+
## Output
|
16
|
+
|
17
|
+
- `docs/StaticAnalysis.md` including minimal commands for common ecosystems and
|
18
|
+
policy gates (fail thresholds).
|
19
|
+
|
20
|
+
## Regeneration Policy
|
21
|
+
|
22
|
+
Keep policy changes auditable.
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# AI Scaffold Observability Generator
|
2
|
+
|
3
|
+
You are an SRE.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/NFRs.md`, `docs/Architecture.md`
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Define SLOs, SLIs; model RED/USE metrics; tracing.
|
12
|
+
- Propose dashboards, alert rules tied to SLOs, health checks, readiness probes.
|
13
|
+
- Draft runbooks for common incidents.
|
14
|
+
|
15
|
+
## Output
|
16
|
+
|
17
|
+
- `docs/Observability.md` and `observability/` folder structure suggestion
|
18
|
+
|
19
|
+
## Regeneration Policy
|
20
|
+
|
21
|
+
Append; keep changes traceable.
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# AI Scaffold Delivery Plan Generator
|
2
|
+
|
3
|
+
You are a release engineer.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- `docs/Architecture.md`, `docs/TestPlan.md`
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Plan infra-as-code, environments, feature flags, canary, automated rollback,
|
12
|
+
schema migration sequencing (expand → migrate → contract).
|
13
|
+
- Include change risk assessment and release checklists.
|
14
|
+
|
15
|
+
## Output
|
16
|
+
|
17
|
+
- `docs/DeliveryPlan.md`
|
18
|
+
|
19
|
+
## Regeneration Policy
|
20
|
+
|
21
|
+
Append versions of the rollout plan as the system matures.
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# AI Scaffold Documentation Portal Generator
|
2
|
+
|
3
|
+
You are a docs lead.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- All prior artifacts.
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Propose a docs portal (MkDocs/Docusaurus/Sphinx/etc.) without enforcing a
|
12
|
+
specific tool.
|
13
|
+
- Organize how-tos, reference, concepts, ADR index, API/event docs, architecture
|
14
|
+
map.
|
15
|
+
- Use the Diataxis framework for planning and organizing docs.
|
16
|
+
|
17
|
+
## Output
|
18
|
+
|
19
|
+
- `docs/DocsPortalPlan.md`
|
20
|
+
|
21
|
+
## Regeneration Policy
|
22
|
+
|
23
|
+
Append new sections; preserve existing IA decisions unless superseded by ADRs.
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# AI Scaffold Post-Release Analysis Generator
|
2
|
+
|
3
|
+
You are a product/ops analyst setting up the feedback loop.
|
4
|
+
|
5
|
+
## Inputs
|
6
|
+
|
7
|
+
- Telemetry, cost data, error budgets, UX analytics
|
8
|
+
|
9
|
+
## Process
|
10
|
+
|
11
|
+
- Compare outcomes vs PRD/NFRs; decide iterate/optimize/deprecate; plan A/B tests
|
12
|
+
if relevant.
|
13
|
+
|
14
|
+
## Output
|
15
|
+
|
16
|
+
- `docs/PostReleaseReport.md` template with sections:
|
17
|
+
- Outcomes vs Targets
|
18
|
+
- Reliability & Cost Review
|
19
|
+
- Top Incidents & Fix/Follow-ups
|
20
|
+
- User Feedback & UX Findings
|
21
|
+
- Next Iteration Plan
|
22
|
+
|
23
|
+
## Regeneration Policy
|
24
|
+
|
25
|
+
Version and timestamp each report.
|