Jon Chery
61043dea1b
---ci--- project: atelier phase: 4 milestone: v0.3 status: complete requirements: covered: [ATELIER-80, ATELIER-81, ATELIER-82, ATELIER-83, ATELIER-84, ATELIER-85] partial: [] ---/ci---
5.3 KiB
5.3 KiB
Atelier — Document Manifest
Authoritative index. If a document is not listed here, it is not part of the framework.
Reading Order
core/first-principles.md— Required firstcore/conflict-resolution.md— Requireddomains/<relevant>/first-principles.md— Per taskdomains/<relevant>/<topic>.md— As neededmatrix/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 |
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 examples populate this section.
| Path | Status | Notes |
|---|---|---|
examples/good/ |
(pending P5) | Good-example directory — to be populated by v0.3 P5 |
examples/bad/ |
(pending P5) | Bad-example directory — to be populated by v0.3 P5 |
examples/good/api-endpoint.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/good/react-component.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/good/db-schema.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/good/error-handler.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/bad/god-object.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/bad/silent-error.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/bad/leaky-abstraction.md |
(pending P5) | v0.1 example — to be listed when P5 back-fills |
examples/good/terraform-module.md |
(pending P5) | v0.2 example — to be listed when P5 back-fills |
examples/good/k8s-deployment.md |
(pending P5) | v0.2 example — to be listed when P5 back-fills |
examples/bad/terraform-unlocked-state.md |
(pending P5) | v0.2 example — to be listed when P5 back-fills |
examples/bad/k8s-bare-pod-no-resources.md |
(pending P5) | v0.2 example — to be listed when P5 back-fills |
examples/good/gitops-pr.md |
(pending P5) | v0.3 example — to be authored in P5 |
examples/good/ai-ml-reproducibility.md |
(pending P5) | v0.3 example — to be authored in P5 |
examples/bad/i18n-string-concat.md |
(pending P5) | v0.3 example — to be authored in P5 |
examples/bad/compliance-audit-log.md |
(pending P5) | v0.3 example — to be authored in P5 |
Note: The
examples/section structure is established here (P4) so P5 can populate it. Files marked "pending P5" do not yet exist; they will be authored in Phase 5 and promoted frompendingto✓upon completion. Listing them here aspendingmakes the manifest authoritative about what will exist and prevents drift.
Cross-Cutting
| Document | Purpose |
|---|---|
matrix/principles-matrix.md |
Maps domain → core principles (17 domains, 170 P-rules post-v0.3) |
matrix/domain-coverage.md |
Maps core → domains; per-domain coverage (incl. v0.3 Core Principle Coverage) |
review/agent-checklist.md |
Pre-completion agent checklist (incl. IaC + k8s + gitops + ai-ml + i18n + compliance triggers) |
review/peer-review-checklist.md |
Human peer-review checklist (incl. IaC + k8s + gitops + ai-ml + i18n + compliance sections) |
review/anti-patterns.md |
Catalog of violations (incl. IaC + k8s + gitops + ai-ml + i18n + compliance + v0.3 chaos anti-patterns) |