special-agents 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.
- package/README.md +69 -0
- package/content/agents/builder.yaml +25 -0
- package/content/agents/planner.yaml +13 -0
- package/content/agents/qa.yaml +16 -0
- package/content/agents/ticket-maker.yaml +11 -0
- package/content/defaults.yaml +13 -0
- package/content/docs/README.md +42 -0
- package/content/docs/admins.md +46 -0
- package/content/docs/ai-costs.md +38 -0
- package/content/docs/ai-evals.md +55 -0
- package/content/docs/ai.md +141 -0
- package/content/docs/api.md +51 -0
- package/content/docs/architecture.md +61 -0
- package/content/docs/business.md +49 -0
- package/content/docs/data-governance.md +67 -0
- package/content/docs/decisions/0000-template.md +29 -0
- package/content/docs/decisions/README.md +30 -0
- package/content/docs/docs.index.yaml +25 -0
- package/content/docs/features.md +41 -0
- package/content/docs/local-cloud.md +58 -0
- package/content/docs/operations.md +69 -0
- package/content/docs/release-checklist.md +56 -0
- package/content/docs/scalability.md +81 -0
- package/content/docs/security.md +82 -0
- package/content/docs/tickets.md +45 -0
- package/content/docs/users.md +43 -0
- package/content/preamble.md +13 -0
- package/content/rules/base/code-quality.md +20 -0
- package/content/rules/base/core.md +17 -0
- package/content/rules/base/definition-of-done.md +21 -0
- package/content/rules/base/git-safety.md +16 -0
- package/content/rules/base/response-expectations.md +18 -0
- package/content/rules/domain/accessibility.md +14 -0
- package/content/rules/domain/ai-cost.md +21 -0
- package/content/rules/domain/ai-evals.md +25 -0
- package/content/rules/domain/ai-governance.md +16 -0
- package/content/rules/domain/ai-reproducibility.md +19 -0
- package/content/rules/domain/ai-safety.md +19 -0
- package/content/rules/domain/data-governance.md +17 -0
- package/content/rules/domain/observability.md +18 -0
- package/content/rules/domain/robustness.md +21 -0
- package/content/rules/domain/scalability.md +18 -0
- package/content/rules/domain/security.md +28 -0
- package/content/rules/packs.index.yaml +177 -0
- package/content/rules/process/api-docs.md +16 -0
- package/content/rules/process/architecture.md +14 -0
- package/content/rules/process/business-docs.md +13 -0
- package/content/rules/process/ci.md +18 -0
- package/content/rules/process/dependencies.md +17 -0
- package/content/rules/process/project-docs.md +35 -0
- package/content/rules/process/release.md +16 -0
- package/content/rules/process/tdd.md +16 -0
- package/content/rules/process/testing.md +28 -0
- package/content/rules/process/tickets.md +17 -0
- package/content/rules/templated/database.md +16 -0
- package/content/rules/templated/infra.md +18 -0
- package/content/rules/templated/stack.md +19 -0
- package/content/skills/better-sqlite3-rebuild/SKILL.md +14 -0
- package/content/skills/grill-me/SKILL.md +10 -0
- package/content/skills/improve-codebase-architecture/REFERENCE.md +78 -0
- package/content/skills/improve-codebase-architecture/SKILL.md +76 -0
- package/content/skills/prd-to-issues/SKILL.md +92 -0
- package/content/skills/tdd/SKILL.md +107 -0
- package/content/skills/tdd/deep-modules.md +33 -0
- package/content/skills/tdd/interface-design.md +31 -0
- package/content/skills/tdd/mocking.md +59 -0
- package/content/skills/tdd/refactoring.md +10 -0
- package/content/skills/tdd/tests.md +61 -0
- package/content/skills/write-a-prd/SKILL.md +74 -0
- package/dist/agents.d.ts +11 -0
- package/dist/agents.js +31 -0
- package/dist/compile.d.ts +79 -0
- package/dist/compile.js +113 -0
- package/dist/content.d.ts +49 -0
- package/dist/content.js +73 -0
- package/dist/index.d.ts +12 -0
- package/dist/index.js +12 -0
- package/dist/resolve.d.ts +46 -0
- package/dist/resolve.js +54 -0
- package/dist/skills.d.ts +11 -0
- package/dist/skills.js +45 -0
- package/dist/template.d.ts +22 -0
- package/dist/template.js +34 -0
- package/node_modules/rafi-spec/dist/index.d.ts +4 -0
- package/node_modules/rafi-spec/dist/index.js +4 -0
- package/node_modules/rafi-spec/dist/schemas.d.ts +185 -0
- package/node_modules/rafi-spec/dist/schemas.js +95 -0
- package/node_modules/rafi-spec/dist/types.d.ts +111 -0
- package/node_modules/rafi-spec/dist/types.js +6 -0
- package/node_modules/rafi-spec/dist/validate.d.ts +16 -0
- package/node_modules/rafi-spec/dist/validate.js +40 -0
- package/node_modules/rafi-spec/package.json +35 -0
- package/node_modules/rafi-spec/src/index.ts +19 -0
- package/node_modules/rafi-spec/src/schemas.ts +102 -0
- package/node_modules/rafi-spec/src/types.ts +134 -0
- package/node_modules/rafi-spec/src/validate.ts +60 -0
- package/package.json +39 -0
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# Data Governance
|
|
2
|
+
|
|
3
|
+
Use this document to define how the app classifies, stores, uses, deletes, exports, and protects data.
|
|
4
|
+
|
|
5
|
+
## Data Owners
|
|
6
|
+
|
|
7
|
+
- Product owner:
|
|
8
|
+
- Engineering owner:
|
|
9
|
+
- Security/privacy owner:
|
|
10
|
+
- Last reviewed:
|
|
11
|
+
|
|
12
|
+
## Data Classification
|
|
13
|
+
|
|
14
|
+
| Classification | Examples | Storage Rules | Access Rules | Retention |
|
|
15
|
+
|---|---|---|---|---|
|
|
16
|
+
| Public | `<examples>` | `<rules>` | `<rules>` | `<retention>` |
|
|
17
|
+
| Internal | `<examples>` | `<rules>` | `<rules>` | `<retention>` |
|
|
18
|
+
| Confidential | `<examples>` | `<rules>` | `<rules>` | `<retention>` |
|
|
19
|
+
| PII | `<examples>` | `<rules>` | `<rules>` | `<retention>` |
|
|
20
|
+
| Secrets | `<examples>` | `<rules>` | `<rules>` | `<retention>` |
|
|
21
|
+
| Training/Eval Data | `<examples>` | `<rules>` | `<rules>` | `<retention>` |
|
|
22
|
+
|
|
23
|
+
## Data Inventory
|
|
24
|
+
|
|
25
|
+
| Data Type | Source | Purpose | Stored Where | Sensitive? | Retention | Deletion/Export |
|
|
26
|
+
|---|---|---|---|---|---|---|
|
|
27
|
+
| `<data>` | `<source>` | `<purpose>` | `<store>` | `<yes/no>` | `<period>` | `<process>` |
|
|
28
|
+
|
|
29
|
+
## Consent And Usage
|
|
30
|
+
|
|
31
|
+
- User consent requirements:
|
|
32
|
+
- Analytics/tracking consent:
|
|
33
|
+
- AI replay/eval usage:
|
|
34
|
+
- Model training usage:
|
|
35
|
+
- External sharing:
|
|
36
|
+
|
|
37
|
+
## Retention, Deletion, And Export
|
|
38
|
+
|
|
39
|
+
- Retention policy:
|
|
40
|
+
- Deletion process:
|
|
41
|
+
- Export process:
|
|
42
|
+
- Backup retention:
|
|
43
|
+
- Legal/compliance holds:
|
|
44
|
+
|
|
45
|
+
## AI Data Rules
|
|
46
|
+
|
|
47
|
+
- Prompt/input storage:
|
|
48
|
+
- Output storage:
|
|
49
|
+
- Replay logs:
|
|
50
|
+
- Eval datasets:
|
|
51
|
+
- Correction datasets:
|
|
52
|
+
- Fine-tuning/custom training data:
|
|
53
|
+
- Dataset source approval:
|
|
54
|
+
- Labeling process:
|
|
55
|
+
- Dataset versioning:
|
|
56
|
+
- Consent for training:
|
|
57
|
+
- PII redaction/tokenization:
|
|
58
|
+
|
|
59
|
+
## Access Controls
|
|
60
|
+
|
|
61
|
+
| Data | Who Can Access | Approval Needed? | Audit Logged? |
|
|
62
|
+
|---|---|---|---|
|
|
63
|
+
| `<data>` | `<roles>` | `<yes/no>` | `<yes/no>` |
|
|
64
|
+
|
|
65
|
+
## Open Risks
|
|
66
|
+
|
|
67
|
+
- `<risk>`
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# ADR 0000: `<Decision Title>`
|
|
2
|
+
|
|
3
|
+
- Status: `<Proposed/Accepted/Superseded/Rejected/Deprecated>`
|
|
4
|
+
- Date: `<YYYY-MM-DD>`
|
|
5
|
+
- Owner: `<name/team>`
|
|
6
|
+
- Related tickets/docs: `<links>`
|
|
7
|
+
|
|
8
|
+
## Context
|
|
9
|
+
|
|
10
|
+
What problem are we solving, and why does the decision matter?
|
|
11
|
+
|
|
12
|
+
## Decision
|
|
13
|
+
|
|
14
|
+
What did we decide?
|
|
15
|
+
|
|
16
|
+
## Alternatives Considered
|
|
17
|
+
|
|
18
|
+
| Option | Pros | Cons | Reason Not Chosen |
|
|
19
|
+
|---|---|---|---|
|
|
20
|
+
| `<option>` | `<pros>` | `<cons>` | `<reason>` |
|
|
21
|
+
|
|
22
|
+
## Consequences
|
|
23
|
+
|
|
24
|
+
What becomes easier, harder, cheaper, more expensive, safer, riskier, or more constrained because of this decision?
|
|
25
|
+
|
|
26
|
+
## Follow-Up
|
|
27
|
+
|
|
28
|
+
- `<ticket or action>`
|
|
29
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Decision History
|
|
2
|
+
|
|
3
|
+
Use this index to track architecture decision records and other meaningful project decisions.
|
|
4
|
+
|
|
5
|
+
## Decision Process
|
|
6
|
+
|
|
7
|
+
- Record decisions that affect architecture, product behavior, data, vendors, cloud, AI/model choices, cost, security, compliance, or operations.
|
|
8
|
+
- Keep each ADR short: context, decision, alternatives considered, consequences, date, and status.
|
|
9
|
+
- Update this index whenever an ADR is added or superseded.
|
|
10
|
+
|
|
11
|
+
## Status Values
|
|
12
|
+
|
|
13
|
+
- `Proposed`
|
|
14
|
+
- `Accepted`
|
|
15
|
+
- `Superseded`
|
|
16
|
+
- `Rejected`
|
|
17
|
+
- `Deprecated`
|
|
18
|
+
|
|
19
|
+
## Decision Index
|
|
20
|
+
|
|
21
|
+
| ID | Title | Status | Date | Owner | Link |
|
|
22
|
+
|---|---|---|---|---|---|
|
|
23
|
+
| `0000` | ADR template | `Template` | `<date>` | `<owner>` | [`0000-template.md`](./0000-template.md) |
|
|
24
|
+
|
|
25
|
+
## Open Decision Questions
|
|
26
|
+
|
|
27
|
+
| Question | Why It Matters | Needed By | Owner | Status |
|
|
28
|
+
|---|---|---|---|---|
|
|
29
|
+
| `<question>` | `<impact>` | `<date>` | `<owner>` | `<status>` |
|
|
30
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Starter documentation templates. `rafi create` copies these into a target repo's
|
|
2
|
+
# docs/ folder, honoring `gate` against the project flags (see ProjectFlags).
|
|
3
|
+
# gate: always -> always copied
|
|
4
|
+
# gate: ai -> copied only when flags.usesAI
|
|
5
|
+
# gate: frontend -> copied only when flags.hasFrontend
|
|
6
|
+
docs:
|
|
7
|
+
- { path: README.md, gate: always }
|
|
8
|
+
- { path: architecture.md, gate: always }
|
|
9
|
+
- { path: features.md, gate: always }
|
|
10
|
+
- { path: api.md, gate: always }
|
|
11
|
+
- { path: users.md, gate: always }
|
|
12
|
+
- { path: admins.md, gate: always }
|
|
13
|
+
- { path: business.md, gate: always }
|
|
14
|
+
- { path: operations.md, gate: always }
|
|
15
|
+
- { path: security.md, gate: always }
|
|
16
|
+
- { path: data-governance.md, gate: always }
|
|
17
|
+
- { path: local-cloud.md, gate: always }
|
|
18
|
+
- { path: scalability.md, gate: always }
|
|
19
|
+
- { path: tickets.md, gate: always }
|
|
20
|
+
- { path: release-checklist.md, gate: always }
|
|
21
|
+
- { path: decisions/README.md, gate: always }
|
|
22
|
+
- { path: decisions/0000-template.md, gate: always }
|
|
23
|
+
- { path: ai.md, gate: ai }
|
|
24
|
+
- { path: ai-evals.md, gate: ai }
|
|
25
|
+
- { path: ai-costs.md, gate: ai }
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Feature Digest
|
|
2
|
+
|
|
3
|
+
Use this document to track what the app does, who can use each feature, and what workflows matter.
|
|
4
|
+
|
|
5
|
+
## Product Summary
|
|
6
|
+
|
|
7
|
+
- Product purpose:
|
|
8
|
+
- Primary user value:
|
|
9
|
+
- Current release stage:
|
|
10
|
+
- Last reviewed:
|
|
11
|
+
|
|
12
|
+
## User Roles
|
|
13
|
+
|
|
14
|
+
| Role | Description | Permissions | Notes |
|
|
15
|
+
|---|---|---|---|
|
|
16
|
+
| `<role>` | `<description>` | `<permissions>` | `<notes>` |
|
|
17
|
+
|
|
18
|
+
## Features
|
|
19
|
+
|
|
20
|
+
| Feature | Users/Roles | Status | Business Value | Docs | Tickets |
|
|
21
|
+
|---|---|---|---|---|---|
|
|
22
|
+
| `<feature>` | `<roles>` | `<planned/live>` | `<value>` | `<link>` | `<ticket>` |
|
|
23
|
+
|
|
24
|
+
## Core Workflows
|
|
25
|
+
|
|
26
|
+
| Workflow | Actor | Start | End | Happy Path | Failure/Edge States |
|
|
27
|
+
|---|---|---|---|---|---|
|
|
28
|
+
| `<workflow>` | `<role>` | `<start>` | `<end>` | `<steps>` | `<states>` |
|
|
29
|
+
|
|
30
|
+
## Permissions Matrix
|
|
31
|
+
|
|
32
|
+
| Capability | Normal User | Admin | Other Roles |
|
|
33
|
+
|---|---|---|---|
|
|
34
|
+
| `<capability>` | `<yes/no>` | `<yes/no>` | `<notes>` |
|
|
35
|
+
|
|
36
|
+
## Future Ideas
|
|
37
|
+
|
|
38
|
+
Add future ideas to `docs/tickets.md`; summarize only major themes here.
|
|
39
|
+
|
|
40
|
+
- `<idea/theme>`
|
|
41
|
+
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Local And Cloud Runtime
|
|
2
|
+
|
|
3
|
+
Use this document to keep local development and cloud deployment expectations clear.
|
|
4
|
+
|
|
5
|
+
## Runtime Summary
|
|
6
|
+
|
|
7
|
+
- Local runtime supported: `<yes/no>`
|
|
8
|
+
- Cloud runtime supported: `<yes/no>`
|
|
9
|
+
- Default cloud provider:
|
|
10
|
+
- Infrastructure as Code tool:
|
|
11
|
+
- Last reviewed:
|
|
12
|
+
|
|
13
|
+
## Local Development
|
|
14
|
+
|
|
15
|
+
- Setup command:
|
|
16
|
+
- Run command:
|
|
17
|
+
- Test command:
|
|
18
|
+
- Required services:
|
|
19
|
+
- Seed data:
|
|
20
|
+
- Local URLs:
|
|
21
|
+
- Local secrets process:
|
|
22
|
+
|
|
23
|
+
## Cloud Runtime
|
|
24
|
+
|
|
25
|
+
- Provider/account:
|
|
26
|
+
- Region(s):
|
|
27
|
+
- Services:
|
|
28
|
+
- Deployment command/process:
|
|
29
|
+
- Secrets:
|
|
30
|
+
- Domains:
|
|
31
|
+
- Monitoring:
|
|
32
|
+
- Rollback:
|
|
33
|
+
|
|
34
|
+
## Parity Matrix
|
|
35
|
+
|
|
36
|
+
| Capability | Local | Cloud | Difference | Reason |
|
|
37
|
+
|---|---|---|---|---|
|
|
38
|
+
| `<capability>` | `<behavior>` | `<behavior>` | `<difference>` | `<reason>` |
|
|
39
|
+
|
|
40
|
+
## Infrastructure As Code
|
|
41
|
+
|
|
42
|
+
- Tool:
|
|
43
|
+
- Entrypoint:
|
|
44
|
+
- State management:
|
|
45
|
+
- Environments:
|
|
46
|
+
- Manual steps:
|
|
47
|
+
- Known gaps:
|
|
48
|
+
|
|
49
|
+
## Environment Variables
|
|
50
|
+
|
|
51
|
+
| Variable | Local | Cloud | Required? | Notes |
|
|
52
|
+
|---|---|---|---|---|
|
|
53
|
+
| `<VAR>` | `<value/source>` | `<secret/source>` | `<yes/no>` | `<notes>` |
|
|
54
|
+
|
|
55
|
+
## Open Questions
|
|
56
|
+
|
|
57
|
+
- `<question>`
|
|
58
|
+
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# Operations Guide
|
|
2
|
+
|
|
3
|
+
Use this document for deployment, monitoring, incident response, backups, and production operations.
|
|
4
|
+
|
|
5
|
+
## Operational Summary
|
|
6
|
+
|
|
7
|
+
- Environments:
|
|
8
|
+
- Deployment owner:
|
|
9
|
+
- Monitoring owner:
|
|
10
|
+
- Support path:
|
|
11
|
+
- Last reviewed:
|
|
12
|
+
|
|
13
|
+
## Environments
|
|
14
|
+
|
|
15
|
+
| Environment | Purpose | URL/Access | Data | Notes |
|
|
16
|
+
|---|---|---|---|---|
|
|
17
|
+
| Local | Development | `<url>` | `<local/seed>` | `<notes>` |
|
|
18
|
+
| Staging | Pre-production | `<url>` | `<data>` | `<notes>` |
|
|
19
|
+
| Production | Live users | `<url>` | `<data>` | `<notes>` |
|
|
20
|
+
|
|
21
|
+
## Deployments
|
|
22
|
+
|
|
23
|
+
- Deployment command/process:
|
|
24
|
+
- Required checks:
|
|
25
|
+
- Migration process:
|
|
26
|
+
- Rollback process:
|
|
27
|
+
- Post-deploy smoke tests:
|
|
28
|
+
|
|
29
|
+
## Monitoring And Alerts
|
|
30
|
+
|
|
31
|
+
| Signal | Tool/Dashboard | Alert Threshold | Owner | Runbook |
|
|
32
|
+
|---|---|---|---|---|
|
|
33
|
+
| `<signal>` | `<tool>` | `<threshold>` | `<owner>` | `<link>` |
|
|
34
|
+
|
|
35
|
+
## Runbooks
|
|
36
|
+
|
|
37
|
+
### `<Incident Or Task>`
|
|
38
|
+
|
|
39
|
+
- Symptoms:
|
|
40
|
+
- Severity:
|
|
41
|
+
- First checks:
|
|
42
|
+
- Recovery steps:
|
|
43
|
+
- Escalation:
|
|
44
|
+
- Follow-up:
|
|
45
|
+
|
|
46
|
+
## Backups And Restore
|
|
47
|
+
|
|
48
|
+
- Backup scope:
|
|
49
|
+
- Backup cadence:
|
|
50
|
+
- Restore test cadence:
|
|
51
|
+
- Restore steps:
|
|
52
|
+
- Retention:
|
|
53
|
+
|
|
54
|
+
## Incident Response
|
|
55
|
+
|
|
56
|
+
- Severity levels:
|
|
57
|
+
- Communication path:
|
|
58
|
+
- Incident commander:
|
|
59
|
+
- Customer communication:
|
|
60
|
+
- Postmortem requirements:
|
|
61
|
+
|
|
62
|
+
## AI Operations
|
|
63
|
+
|
|
64
|
+
- AI provider dashboards:
|
|
65
|
+
- Cost alerts:
|
|
66
|
+
- Abuse monitoring:
|
|
67
|
+
- Eval/regression checks:
|
|
68
|
+
- AI incident response:
|
|
69
|
+
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Release Checklist
|
|
2
|
+
|
|
3
|
+
Use this checklist before releases that affect users, production data, public APIs, infrastructure, billing, auth, or AI behavior.
|
|
4
|
+
|
|
5
|
+
## Release Summary
|
|
6
|
+
|
|
7
|
+
- Release name/version:
|
|
8
|
+
- Release owner:
|
|
9
|
+
- Target date:
|
|
10
|
+
- Risk level:
|
|
11
|
+
- Rollback owner:
|
|
12
|
+
|
|
13
|
+
## Pre-Release
|
|
14
|
+
|
|
15
|
+
- [ ] Requested behavior is complete.
|
|
16
|
+
- [ ] Relevant tickets are updated.
|
|
17
|
+
- [ ] Relevant tests pass.
|
|
18
|
+
- [ ] Typecheck/static analysis passes.
|
|
19
|
+
- [ ] Lint/format checks pass.
|
|
20
|
+
- [ ] Build passes.
|
|
21
|
+
- [ ] Database migrations are reviewed and tested.
|
|
22
|
+
- [ ] API docs are updated.
|
|
23
|
+
- [ ] User/admin docs are updated.
|
|
24
|
+
- [ ] Architecture/business/operations docs are updated where relevant.
|
|
25
|
+
- [ ] Security, data-governance, and privacy impacts are reviewed.
|
|
26
|
+
- [ ] AI evals pass where relevant.
|
|
27
|
+
- [ ] AI/model cost impact is reviewed where relevant.
|
|
28
|
+
- [ ] Environment variables and secrets are documented.
|
|
29
|
+
- [ ] Monitoring dashboards and alerts are ready.
|
|
30
|
+
- [ ] Rollback path is documented and practical.
|
|
31
|
+
|
|
32
|
+
## Deployment
|
|
33
|
+
|
|
34
|
+
- [ ] Deployment started:
|
|
35
|
+
- [ ] Migration completed:
|
|
36
|
+
- [ ] Smoke tests completed:
|
|
37
|
+
- [ ] Monitoring checked:
|
|
38
|
+
- [ ] Error logs checked:
|
|
39
|
+
- [ ] User/admin impact confirmed:
|
|
40
|
+
|
|
41
|
+
## Post-Release
|
|
42
|
+
|
|
43
|
+
- [ ] Changelog updated.
|
|
44
|
+
- [ ] Tickets marked complete.
|
|
45
|
+
- [ ] Follow-up work logged.
|
|
46
|
+
- [ ] Incidents/regressions documented.
|
|
47
|
+
- [ ] Release process improvements logged.
|
|
48
|
+
|
|
49
|
+
## Rollback Plan
|
|
50
|
+
|
|
51
|
+
- Trigger:
|
|
52
|
+
- Steps:
|
|
53
|
+
- Data considerations:
|
|
54
|
+
- Communication:
|
|
55
|
+
- Verification:
|
|
56
|
+
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Scalability Plan
|
|
2
|
+
|
|
3
|
+
Use this document to describe how the app should scale locally, in cloud environments, and across major system areas.
|
|
4
|
+
|
|
5
|
+
## Current Status
|
|
6
|
+
|
|
7
|
+
- Expected users:
|
|
8
|
+
- Expected data size:
|
|
9
|
+
- Expected request volume:
|
|
10
|
+
- Expected AI/model volume:
|
|
11
|
+
- Expected cost constraints:
|
|
12
|
+
- Last reviewed:
|
|
13
|
+
|
|
14
|
+
## Local And Cloud Runtime
|
|
15
|
+
|
|
16
|
+
Unless the project says otherwise, the app should run both locally and in the cloud.
|
|
17
|
+
|
|
18
|
+
| Environment | Runtime Path | Dependencies | Data Strategy | Known Gaps |
|
|
19
|
+
|---|---|---|---|---|
|
|
20
|
+
| Local development | `<command/docker/etc>` | `<services>` | `<seed/local db>` | `<gaps>` |
|
|
21
|
+
| Cloud | `<provider/services>` | `<services>` | `<managed db/storage>` | `<gaps>` |
|
|
22
|
+
|
|
23
|
+
## Server Scaling
|
|
24
|
+
|
|
25
|
+
- Stateless services:
|
|
26
|
+
- Horizontal scaling plan:
|
|
27
|
+
- Background job strategy:
|
|
28
|
+
- Queueing strategy:
|
|
29
|
+
- Rate limiting:
|
|
30
|
+
- Caching:
|
|
31
|
+
- Bottlenecks:
|
|
32
|
+
|
|
33
|
+
## Cloud Scaling
|
|
34
|
+
|
|
35
|
+
- Default cloud provider:
|
|
36
|
+
- Infrastructure as Code tool:
|
|
37
|
+
- Regions:
|
|
38
|
+
- Managed services:
|
|
39
|
+
- Deployment topology:
|
|
40
|
+
- Autoscaling assumptions:
|
|
41
|
+
- Capacity limits:
|
|
42
|
+
- Failover expectations:
|
|
43
|
+
|
|
44
|
+
## Frontend Scaling
|
|
45
|
+
|
|
46
|
+
- Bundle-size strategy:
|
|
47
|
+
- Rendering/performance risks:
|
|
48
|
+
- Loading-state strategy:
|
|
49
|
+
- Mobile performance:
|
|
50
|
+
- Caching:
|
|
51
|
+
- Network request strategy:
|
|
52
|
+
|
|
53
|
+
## Database Scaling
|
|
54
|
+
|
|
55
|
+
- Schema growth assumptions:
|
|
56
|
+
- Index strategy:
|
|
57
|
+
- Query risk areas:
|
|
58
|
+
- Read/write volume:
|
|
59
|
+
- Connection management:
|
|
60
|
+
- Migration strategy:
|
|
61
|
+
- Archival/retention strategy:
|
|
62
|
+
|
|
63
|
+
## AI And Model Scaling
|
|
64
|
+
|
|
65
|
+
- Provider limits:
|
|
66
|
+
- Latency expectations:
|
|
67
|
+
- Concurrency strategy:
|
|
68
|
+
- Queueing/fallback behavior:
|
|
69
|
+
- Cost controls:
|
|
70
|
+
- Model upgrade path:
|
|
71
|
+
- Eval impact of model changes:
|
|
72
|
+
|
|
73
|
+
## Total Architecture Scaling
|
|
74
|
+
|
|
75
|
+
| Area | Current Limit | Scale Trigger | Planned Response | Owner |
|
|
76
|
+
|---|---|---|---|---|
|
|
77
|
+
| `<area>` | `<limit>` | `<trigger>` | `<response>` | `<owner>` |
|
|
78
|
+
|
|
79
|
+
## Open Risks
|
|
80
|
+
|
|
81
|
+
- `<risk>`
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Security Plan
|
|
2
|
+
|
|
3
|
+
Use this document to track the app's security model, threat model, controls, and incident response.
|
|
4
|
+
|
|
5
|
+
## Security Summary
|
|
6
|
+
|
|
7
|
+
- Security owner:
|
|
8
|
+
- Risk level:
|
|
9
|
+
- Auth model:
|
|
10
|
+
- Permission model:
|
|
11
|
+
- Last reviewed:
|
|
12
|
+
|
|
13
|
+
## Authentication And Authorization
|
|
14
|
+
|
|
15
|
+
- Authentication method:
|
|
16
|
+
- Session/token behavior:
|
|
17
|
+
- Password policy:
|
|
18
|
+
- MFA:
|
|
19
|
+
- Role/permission model:
|
|
20
|
+
- Server-side enforcement points:
|
|
21
|
+
|
|
22
|
+
## Secrets Management
|
|
23
|
+
|
|
24
|
+
- Secret storage:
|
|
25
|
+
- Local development secrets:
|
|
26
|
+
- Cloud secrets:
|
|
27
|
+
- Rotation process:
|
|
28
|
+
- Emergency revocation:
|
|
29
|
+
|
|
30
|
+
## Threat Model
|
|
31
|
+
|
|
32
|
+
| Area | Threat | Impact | Mitigation | Status |
|
|
33
|
+
|---|---|---|---|---|
|
|
34
|
+
| `<area>` | `<threat>` | `<impact>` | `<mitigation>` | `<status>` |
|
|
35
|
+
|
|
36
|
+
## Abuse Controls
|
|
37
|
+
|
|
38
|
+
- Rate limiting:
|
|
39
|
+
- Signup/login protection:
|
|
40
|
+
- API abuse protection:
|
|
41
|
+
- AI abuse protection:
|
|
42
|
+
- Admin action controls:
|
|
43
|
+
|
|
44
|
+
## AI Security Controls
|
|
45
|
+
|
|
46
|
+
- Prompt injection protection:
|
|
47
|
+
- Jailbreak protection:
|
|
48
|
+
- Data leakage protection:
|
|
49
|
+
- Tool-use restrictions:
|
|
50
|
+
- Cost-abuse protection:
|
|
51
|
+
- Human review requirements:
|
|
52
|
+
- AI incident escalation:
|
|
53
|
+
|
|
54
|
+
## Security Checks
|
|
55
|
+
|
|
56
|
+
| Check | Tool/Process | Frequency | Owner | Notes |
|
|
57
|
+
|---|---|---|---|---|
|
|
58
|
+
| Dependency scanning | `<tool>` | `<frequency>` | `<owner>` | `<notes>` |
|
|
59
|
+
| Secret scanning | `<tool>` | `<frequency>` | `<owner>` | `<notes>` |
|
|
60
|
+
| Container scanning | `<tool>` | `<frequency>` | `<owner>` | `<notes>` |
|
|
61
|
+
| License checks | `<tool>` | `<frequency>` | `<owner>` | `<notes>` |
|
|
62
|
+
| SBOM generation | `<tool>` | `<frequency>` | `<owner>` | `<notes>` |
|
|
63
|
+
|
|
64
|
+
## Sensitive Actions And Audit Logs
|
|
65
|
+
|
|
66
|
+
| Action | Actor | Audit Fields | Alert? | Notes |
|
|
67
|
+
|---|---|---|---|---|
|
|
68
|
+
| `<action>` | `<actor>` | `<fields>` | `<yes/no>` | `<notes>` |
|
|
69
|
+
|
|
70
|
+
## Security Incident Response
|
|
71
|
+
|
|
72
|
+
- Severity levels:
|
|
73
|
+
- First response steps:
|
|
74
|
+
- Containment:
|
|
75
|
+
- Eradication:
|
|
76
|
+
- Recovery:
|
|
77
|
+
- User/customer communication:
|
|
78
|
+
- Post-incident review:
|
|
79
|
+
|
|
80
|
+
## Known Risks
|
|
81
|
+
|
|
82
|
+
- `<risk>`
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Ticket Log
|
|
2
|
+
|
|
3
|
+
Use this document as the source of truth when no external issue tracker is configured.
|
|
4
|
+
|
|
5
|
+
## Status Values
|
|
6
|
+
|
|
7
|
+
- `Backlog`
|
|
8
|
+
- `Ready`
|
|
9
|
+
- `In Progress`
|
|
10
|
+
- `Blocked`
|
|
11
|
+
- `In Review`
|
|
12
|
+
- `Done`
|
|
13
|
+
- `Won't Do`
|
|
14
|
+
|
|
15
|
+
## Priority Values
|
|
16
|
+
|
|
17
|
+
- `P0`: urgent production/user/business risk
|
|
18
|
+
- `P1`: important near-term work
|
|
19
|
+
- `P2`: useful planned work
|
|
20
|
+
- `P3`: future idea or low urgency
|
|
21
|
+
|
|
22
|
+
## Epics
|
|
23
|
+
|
|
24
|
+
| Epic ID | Title | Status | Business Value | Notes |
|
|
25
|
+
|---|---|---|---|---|
|
|
26
|
+
| `E-001` | `<title>` | `Backlog` | `<value>` | `<notes>` |
|
|
27
|
+
|
|
28
|
+
## Stories And Tickets
|
|
29
|
+
|
|
30
|
+
| ID | Epic | Title | Status | Priority | User/Business Value | Acceptance Criteria | Test Expectations | Notes |
|
|
31
|
+
|---|---|---|---|---|---|---|---|---|
|
|
32
|
+
| `T-001` | `E-001` | `<title>` | `Backlog` | `P2` | `<value>` | `<criteria>` | `<tests>` | `<notes>` |
|
|
33
|
+
|
|
34
|
+
## Follow-Ups And Future Ideas
|
|
35
|
+
|
|
36
|
+
| ID | Source | Idea | Value | Risk/Cost | Status |
|
|
37
|
+
|---|---|---|---|---|---|
|
|
38
|
+
| `F-001` | `<source>` | `<idea>` | `<value>` | `<risk/cost>` | `Backlog` |
|
|
39
|
+
|
|
40
|
+
## Completed Work
|
|
41
|
+
|
|
42
|
+
| ID | Completed Date | Summary | Links |
|
|
43
|
+
|---|---|---|---|
|
|
44
|
+
| `<ticket>` | `<date>` | `<summary>` | `<links>` |
|
|
45
|
+
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# User Guide
|
|
2
|
+
|
|
3
|
+
Use this document for normal user-facing documentation.
|
|
4
|
+
|
|
5
|
+
## Audience
|
|
6
|
+
|
|
7
|
+
- Primary users:
|
|
8
|
+
- Assumed skill level:
|
|
9
|
+
- Last reviewed:
|
|
10
|
+
|
|
11
|
+
## Getting Started
|
|
12
|
+
|
|
13
|
+
1. `<step>`
|
|
14
|
+
2. `<step>`
|
|
15
|
+
3. `<step>`
|
|
16
|
+
|
|
17
|
+
## Common Workflows
|
|
18
|
+
|
|
19
|
+
### `<Workflow Name>`
|
|
20
|
+
|
|
21
|
+
- Goal:
|
|
22
|
+
- Steps:
|
|
23
|
+
- Expected result:
|
|
24
|
+
- Common issues:
|
|
25
|
+
|
|
26
|
+
## Account And Settings
|
|
27
|
+
|
|
28
|
+
- Sign in:
|
|
29
|
+
- Profile/settings:
|
|
30
|
+
- Notifications:
|
|
31
|
+
- Data export/deletion:
|
|
32
|
+
|
|
33
|
+
## Errors And Troubleshooting
|
|
34
|
+
|
|
35
|
+
| Problem | What It Means | What To Do |
|
|
36
|
+
|---|---|---|
|
|
37
|
+
| `<problem>` | `<meaning>` | `<action>` |
|
|
38
|
+
|
|
39
|
+
## Support
|
|
40
|
+
|
|
41
|
+
- Support path:
|
|
42
|
+
- What information to include:
|
|
43
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# App-Level AI Agent Rules
|
|
2
|
+
|
|
3
|
+
Use this file as the canonical project instruction source for AI coding agents.
|
|
4
|
+
|
|
5
|
+
For Codex, copy this content into the repository root as `AGENTS.md`.
|
|
6
|
+
For Claude Code, create a repository-root `CLAUDE.md` that imports the same rules:
|
|
7
|
+
|
|
8
|
+
```md
|
|
9
|
+
@AGENTS.md
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Keep durable process rules in this file. Put detailed project facts in the project documents named below, not in the agent rules.
|
|
13
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: code-quality
|
|
3
|
+
category: base
|
|
4
|
+
description: "Clarity, focused modules, explicit errors, stable interfaces."
|
|
5
|
+
condition: always
|
|
6
|
+
template: false
|
|
7
|
+
---
|
|
8
|
+
## Code Quality
|
|
9
|
+
|
|
10
|
+
- Optimize for clarity over cleverness.
|
|
11
|
+
- Keep functions and modules focused. Extract helpers when they reduce real duplication or clarify complex logic.
|
|
12
|
+
- Avoid oversized files and modules. Split by responsibility when a file becomes difficult to scan or safely change.
|
|
13
|
+
- Use explicit names for variables, functions, components, files, and tests.
|
|
14
|
+
- Add clarifying comments for non-obvious business rules, tradeoffs, edge cases, algorithms, or integration constraints.
|
|
15
|
+
- Avoid comments that merely restate the code.
|
|
16
|
+
- Prefer typed, structured data and schema validation at boundaries.
|
|
17
|
+
- Handle errors explicitly with useful messages and safe failure modes.
|
|
18
|
+
- Keep public interfaces stable unless the task requires a breaking change.
|
|
19
|
+
- Do not add production dependencies without a clear reason. Prefer existing dependencies and standard library capabilities.
|
|
20
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: core
|
|
3
|
+
category: base
|
|
4
|
+
description: "Senior-level working agreement and change discipline."
|
|
5
|
+
condition: always
|
|
6
|
+
template: false
|
|
7
|
+
---
|
|
8
|
+
## Core Working Agreement
|
|
9
|
+
|
|
10
|
+
- Work like a senior or staff-level engineer: keep code simple, readable, well-factored, testable, and easy for another developer to maintain.
|
|
11
|
+
- Do not make changes outside the user's instructions unless they are required to complete the requested work correctly.
|
|
12
|
+
- Prefer small, reviewable changes with clear boundaries. Avoid unrelated refactors unless they are required for the requested change.
|
|
13
|
+
- Follow existing project conventions before introducing new patterns.
|
|
14
|
+
- Make reasonable implementation choices, but ask the user when a decision changes product behavior, cost, security posture, data model, or public API contracts.
|
|
15
|
+
- If you notice unrelated room for improvement, make a note of it and report it when the work is done instead of changing it silently.
|
|
16
|
+
- Never hide uncertainty. If assumptions matter, state them briefly and verify them where practical.
|
|
17
|
+
|