Jon Chery
29ffb42898
---ci--- project: atelier phase: 0 milestone: v0.4 status: complete requirements: covered: [ATELIER-92, ATELIER-93, ATELIER-94, ATELIER-95, ATELIER-96, ATELIER-97, ATELIER-98, ATELIER-99, ATELIER-100, ATELIER-101, ATELIER-102, ATELIER-103, ATELIER-104, ATELIER-105, ATELIER-106, ATELIER-107, ATELIER-108, ATELIER-109, ATELIER-110, ATELIER-111, ATELIER-112, ATELIER-113, ATELIER-114, ATELIER-115, ATELIER-116, ATELIER-117] partial: [] ---/ci---
97 lines
6.6 KiB
Markdown
97 lines
6.6 KiB
Markdown
# Atelier — Document Manifest
|
|
|
|
> Authoritative index. If a document is not listed here, it is not
|
|
> part of the framework.
|
|
|
|
## Reading Order
|
|
|
|
1. `core/first-principles.md` — Required first
|
|
2. `core/conflict-resolution.md` — Required
|
|
3. `domains/<relevant>/first-principles.md`— Per task
|
|
4. `domains/<relevant>/<topic>.md` — As needed
|
|
5. `matrix/principles-matrix.md` — Reference
|
|
|
|
## Core
|
|
|
|
| Document | Status | Audience |
|
|
|-----------------------------------------|----------|----------|
|
|
| `core/first-principles.md` | Stable | All |
|
|
| `core/conflict-resolution.md` | Stable | All |
|
|
| `core/reading-order.md` | Stable | All |
|
|
|
|
## Domains
|
|
|
|
| Domain | First Principles | Derived Documents |
|
|
|---------------|------------------|----------------------------------|
|
|
| UI / UX | ✓ | components, accessibility, tokens, copywriting |
|
|
| API Design | ✓ | rest, graphql, versioning, error-responses, pagination |
|
|
| Security | ✓ | authentication, authorization, input-validation, secrets, supply-chain |
|
|
| Data | ✓ | schema-design, migrations, indexing |
|
|
| Testing | ✓ | pyramid, fixtures |
|
|
| Performance | ✓ | frontend, backend |
|
|
| Observability | ✓ | logging, metrics, tracing |
|
|
| Errors | ✓ | patterns |
|
|
| Documentation | ✓ | doc-templates |
|
|
| Concurrency | ✓ | patterns |
|
|
| DevOps | ✓ | ci-cd, environments |
|
|
| Infrastructure as Code | ✓ | terraform, opentofu, state, modules |
|
|
| Kubernetes | ✓ | workloads, networking, storage, rbac, helm, kustomize |
|
|
| GitOps + Operators | ✓ | argocd, flux, operators, progressive-delivery |
|
|
| AI / ML | ✓ | data-versioning, model-evaluation, serving, monitoring-drift |
|
|
| i18n | ✓ | locale-resources, formatting, rtl-bidi, testing-i18n |
|
|
| Compliance | ✓ | audit-logs, data-retention, policy-as-code, evidence |
|
|
| Edge | ✓ | cdn, offline-first, iot, sync |
|
|
| Messaging | ✓ | queues, pubsub, streams, delivery-semantics |
|
|
|
|
## Languages
|
|
|
|
> Language docs apply (not derive) domain principles. They introduce
|
|
> no new P-rules and no new matrix rows (D-063, D-066). First-
|
|
> principles stubs from v0.1; derived docs added in v0.4.
|
|
|
|
| Language | First Principles | Derived Documents |
|
|
|----------|------------------|-------------------|
|
|
| TypeScript | ✓ (v0.1 stub) | ts-types, ts-tooling, ts-async, ts-testing |
|
|
| Python | ✓ (v0.1 stub) | py-types, py-tooling, py-async, py-testing |
|
|
| Go | ✓ (v0.1 stub) | go-types, go-tooling, go-concurrency, go-testing |
|
|
| Rust | ✓ (v0.1 stub) | rs-ownership, rs-tooling, rs-async, rs-testing |
|
|
|
|
## Examples
|
|
|
|
> Examples are illustrative markdown with fenced code only (no standalone runtime artifacts per D-020 / D-025). The `examples/` directory listing closes the v0.2 ESC-002 drift (IDEATE-17, ATELIER-91). P5 authored the v0.3 examples and promoted all entries from `pending` to `✓` (verified — every listed file exists). P5 also authored the 4 v0.4 examples (edge + messaging chaos anti-patterns + good examples) and listed them here.
|
|
|
|
| Path | Status | Notes |
|
|
|------|--------|-------|
|
|
| `examples/good/` | ✓ | Good-example directory — 10 examples (v0.1 + v0.2 + v0.3 + v0.4) |
|
|
| `examples/bad/` | ✓ | Bad-example directory — 9 examples (v0.1 + v0.2 + v0.3 + v0.4) |
|
|
| `examples/good/api-endpoint.md` | ✓ | v0.1 example — good REST endpoint |
|
|
| `examples/good/react-component.md` | ✓ | v0.1 example — good React component |
|
|
| `examples/good/db-schema.md` | ✓ | v0.1 example — good DB schema |
|
|
| `examples/good/error-handler.md` | ✓ | v0.1 example — good error handler |
|
|
| `examples/bad/god-object.md` | ✓ | v0.1 example — bad god object |
|
|
| `examples/bad/silent-error.md` | ✓ | v0.1 example — bad silent error |
|
|
| `examples/bad/leaky-abstraction.md` | ✓ | v0.1 example — bad leaky abstraction |
|
|
| `examples/good/terraform-module.md` | ✓ | v0.2 example — good IaC module |
|
|
| `examples/good/k8s-deployment.md` | ✓ | v0.2 example — good k8s deployment |
|
|
| `examples/bad/terraform-unlocked-state.md` | ✓ | v0.2 example — bad unlocked state |
|
|
| `examples/bad/k8s-bare-pod-no-resources.md` | ✓ | v0.2 example — bad bare pod |
|
|
| `examples/good/gitops-pr.md` | ✓ | v0.3 example — good GitOps PR |
|
|
| `examples/good/ai-ml-reproducibility.md` | ✓ | v0.3 example — good reproducible training run |
|
|
| `examples/bad/i18n-string-concat.md` | ✓ | v0.3 example — bad i18n string concat |
|
|
| `examples/bad/compliance-audit-log.md` | ✓ | v0.3 example — bad audit log (P1 + P9 breaches) |
|
|
| `examples/good/edge-offline-sync.md` | ✓ | v0.4 example — good edge offline-first + sync reconcile (CRDT-vs-LWW decision matrix) |
|
|
| `examples/good/messaging-idempotent-consumer.md` | ✓ | v0.4 example — good idempotent consumer with dedup store + DLQ |
|
|
| `examples/bad/edge-sync-loop.md` | ✓ | v0.4 example — bad edge sync livelock (`edge-sync-loop` chaos anti-pattern, ATELIER-110) |
|
|
| `examples/bad/messaging-shared-subscription.md` | ✓ | v0.4 example — bad messaging shared subscription (`messaging-shared-subscription` chaos anti-pattern, ATELIER-110) |
|
|
|
|
> **Note:** The `examples/` section was established in P4 with entries pre-listed as `pending P5`. P5 authored the 4 v0.3 examples and the 4 v0.4 examples, and promoted all entries to `✓` after verifying every listed file exists on disk. The manifest remains authoritative — unlisted = not part of framework.
|
|
|
|
## Cross-Cutting
|
|
|
|
| Document | Purpose |
|
|
|-----------------------------------|----------------------------------|
|
|
| `matrix/principles-matrix.md` | Maps domain → core principles (19 domains, 190 P-rules post-v0.4) |
|
|
| `matrix/domain-coverage.md` | Maps core → domains; per-domain coverage (incl. v0.4 Core Principle Coverage + Languages Coverage sub-table) |
|
|
| `review/agent-checklist.md` | Pre-completion agent checklist (incl. edge + messaging + language-derived triggers) |
|
|
| `review/peer-review-checklist.md` | Human peer-review checklist (incl. edge + messaging + language-derived sections) |
|
|
| `review/anti-patterns.md` | Catalog of violations (incl. edge + messaging + language-derived + v0.4 chaos anti-patterns + .ts/.py/.go/.rs artifact types) | |