Artifact Templates — design-code-architecture skill

Skeletons this metaskill creates in the user's docs/ folder.

by wondelai·MIT license·★ 2,235 Stars on the repo·GitHub ↗

Use now

Files of Artifact Templates — design-code-architecture

wondelai/main1 file
artifact-templates.md
Show the full text87 lines
artifact-templates-design-code-architecture/artifact-templates.md87 lines · 3.2 KB

Artifact Templates — design-code-architecture

Skeletons this metaskill creates in the user's docs/ folder. Extend-only artifacts (TECH-DEBT.md, TESTING.md, OPERATIONS.md) are governed by the section headings named in each phase, not duplicated here. Copy a skeleton verbatim the first time you create its file; on later phases, extend the existing file — add or update your own sections, preserve everyone else's.

docs/DESIGN-CODE-ARCHITECTURE-PLAN.md (tracker)

Created on first run; never shared with other journeys. The Phase Status table is pre-filled with this journey's real phases.

# Design Code Architecture Plan

## Context
Intake answers, date started, project specifics (stack, core differentiator, year-one load, outbound dependencies, system of record, number of owning teams).

## Phase Status
| Phase | Skill | Status | Artifact | Date |
|---|---|---|---|---|
| 1 — Draw the boundaries | clean-architecture | pending | ARCHITECTURE.md | |
| 2 — Model the domain | domain-driven-design | pending | ARCHITECTURE.md | |
| 3 — Size the system | system-design | pending | ARCHITECTURE.md | |
| 4 — Make data decisions | ddia-systems | pending | ARCHITECTURE.md | |
| 5 — Keep modules deep | software-design-philosophy | pending | TECH-DEBT.md | |
| 6 — Design for failure | release-it | pending | RELIABILITY.md | |
| 7 — Prove wiring, lock in habits | pragmatic-programmer | pending | TESTING.md + TECH-DEBT.md | |
| 8 — Cut scope to essential | 37signals-way | pending | ARCHITECTURE.md + TECH-DEBT.md | |
| Optional — Align teams to boundaries | team-topologies | pending | OPERATIONS.md | |
Statuses: pending · in-progress · awaiting-evidence · done · deferred: <reason> · skipped: <reason>

## Key Decisions
| Date | Phase | Decision | Rationale |
|---|---|---|---|

## Next Actions
- [ ] action (owner, due)

docs/ARCHITECTURE.md

Created in Phase 1; extended in Phases 2, 3, 4, and 8. System structure and decisions — includes the domain model and data decisions (no separate DATA.md or DOMAIN.md).

# Architecture

## System Context
What the system does, key integrations, load reality (back-of-envelope numbers).

## Layer Map & Dependency Rule
Layers, what depends on what, current violations.
| Violation | Location | Fix | Status |
|---|---|---|---|

## Bounded Contexts & Context Map
Contexts, relationships, anti-corruption layers.

## Domain Glossary (Ubiquitous Language)
| Term | Meaning | Code name |
|---|---|---|

## Data & Storage Decisions
Data models, storage engines, isolation levels, replication, system-of-record vs derived data.

## Decision Log
| Date | Decision | Why | Alternatives rejected |
|---|---|---|---|

docs/RELIABILITY.md

Created in Phase 6. Production hardening status.

# Reliability

## Integration-Point Audit
| Dependency | Timeout | Circuit breaker | Bulkhead | Retry policy | Status |
|---|---|---|---|---|---|

## Query & Resource Findings
Unbounded result sets, missing LIMITs/pagination, blocked threads.

## Health Checks & Metrics
Deep health checks · RED metrics · symptom-based alerts.

## Deploy vs Release
Feature flags, expand-contract migrations, rollback plan.
1# Artifact Templates — design-code-architecture
2 
3Skeletons this metaskill creates in the user's `docs/` folder. Extend-only artifacts (TECH-DEBT.md, TESTING.md, OPERATIONS.md) are governed by the section headings named in each phase, not duplicated here. Copy a skeleton verbatim the first time you create its file; on later phases, extend the existing file — add or update your own sections, preserve everyone else's.
4 
5## docs/DESIGN-CODE-ARCHITECTURE-PLAN.md (tracker)
6 
7Created on first run; never shared with other journeys. The Phase Status table is pre-filled with this journey's real phases.
8 
9```markdown
10# Design Code Architecture Plan
11 
12## Context
13Intake answers, date started, project specifics (stack, core differentiator, year-one load, outbound dependencies, system of record, number of owning teams).
14 
15## Phase Status
16| Phase | Skill | Status | Artifact | Date |
17|---|---|---|---|---|
18| 1 — Draw the boundaries | clean-architecture | pending | ARCHITECTURE.md | |
19| 2 — Model the domain | domain-driven-design | pending | ARCHITECTURE.md | |
20| 3 — Size the system | system-design | pending | ARCHITECTURE.md | |
21| 4 — Make data decisions | ddia-systems | pending | ARCHITECTURE.md | |
22| 5 — Keep modules deep | software-design-philosophy | pending | TECH-DEBT.md | |
23| 6 — Design for failure | release-it | pending | RELIABILITY.md | |
24| 7 — Prove wiring, lock in habits | pragmatic-programmer | pending | TESTING.md + TECH-DEBT.md | |
25| 8 — Cut scope to essential | 37signals-way | pending | ARCHITECTURE.md + TECH-DEBT.md | |
26| Optional — Align teams to boundaries | team-topologies | pending | OPERATIONS.md | |
27Statuses: pending · in-progress · awaiting-evidence · done · deferred: <reason> · skipped: <reason>
28 
29## Key Decisions
30| Date | Phase | Decision | Rationale |
31|---|---|---|---|
32 
33## Next Actions
34- [ ] action (owner, due)
35```
36 
37## docs/ARCHITECTURE.md
38 
39Created in Phase 1; extended in Phases 2, 3, 4, and 8. System structure and decisions — includes the domain model and data decisions (no separate DATA.md or DOMAIN.md).
40 
41```markdown
42# Architecture
43 
44## System Context
45What the system does, key integrations, load reality (back-of-envelope numbers).
46 
47## Layer Map & Dependency Rule
48Layers, what depends on what, current violations.
49| Violation | Location | Fix | Status |
50|---|---|---|---|
51 
52## Bounded Contexts & Context Map
53Contexts, relationships, anti-corruption layers.
54 
55## Domain Glossary (Ubiquitous Language)
56| Term | Meaning | Code name |
57|---|---|---|
58 
59## Data & Storage Decisions
60Data models, storage engines, isolation levels, replication, system-of-record vs derived data.
61 
62## Decision Log
63| Date | Decision | Why | Alternatives rejected |
64|---|---|---|---|
65```
66 
67## docs/RELIABILITY.md
68 
69Created in Phase 6. Production hardening status.
70 
71```markdown
72# Reliability
73 
74## Integration-Point Audit
75| Dependency | Timeout | Circuit breaker | Bulkhead | Retry policy | Status |
76|---|---|---|---|---|---|
77 
78## Query & Resource Findings
79Unbounded result sets, missing LIMITs/pagination, blocked threads.
80 
81## Health Checks & Metrics
82Deep health checks · RED metrics · symptom-based alerts.
83 
84## Deploy vs Release
85Feature flags, expand-contract migrations, rollback plan.
86```
87 

Discussion

Alternatives