@pixelfactoryio/theway 0.5.3 → 0.6.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pixelfactoryio/theway",
3
- "version": "0.5.3",
3
+ "version": "0.6.0",
4
4
  "description": "A spec-first workflow for Claude Code",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "theway",
3
- "version": "0.5.3",
3
+ "version": "0.6.0",
4
4
  "description": "theway writes a spec and a numbered task list before any code, then implements the tasks in your session or through agents that open a reviewed, CI-green pull request.",
5
5
  "author": {
6
6
  "name": "Amine",
@@ -34,7 +34,13 @@ docs/architecture/
34
34
 
35
35
  ### Step 1: Generate Documents from Templates
36
36
 
37
- First read `<home>/config.yaml` (and `<home>/data/standards/architecture-principles.md` if enabled in config).
37
+ First read `<home>/config.yaml`, then these opt-in standards:
38
+ - `<home>/data/standards/core-principles.md` - Architecture philosophy (only when `standards.core_principles.enabled` is `true`)
39
+ - `<home>/data/standards/sre.md` - SRE operational excellence (only when `standards.sre.enabled` is `true`)
40
+ - `<home>/data/standards/web-development.md` - Web development standards (only when `standards.web_development.enabled` is `true`)
41
+ - `<home>/data/standards/quality.md` - Quality expectations (only when `standards.quality.enabled` is `true`)
42
+
43
+ An opt-in standard is read only when its `enabled` is the boolean `true`; an absent entry or any other value means off.
38
44
 
39
45
  Then, for each template below, read the template file, follow its frontmatter instructions (required_context, agent_role, workflow_steps, quality_standards, best_practices), and create/update the output file in `docs/architecture/` (overwrite if it already exists). Keep outputs concise — code examples, not verbose explanations.
40
46
 
@@ -10,7 +10,7 @@ You are now scaffolding a Spec analysis using templates.
10
10
 
11
11
  > **What this command produces.** A spec someone else can implement without guessing: the problem, what you found out, the decisions and why, and the tasks. The code is written later, by `/theway:develop`, from that spec.
12
12
  >
13
- > Write only under `<change-dir>`, the change folder `theway path <project> <change-id>` prints (Step 2). Action words in the request ("rename X", "try the fix") describe what the spec should plan, not something to do now.
13
+ > Write only under `<change-dir>`, the change folder `theway path <project> <change-id>` prints (Step 2). Throwaway probes, yours and the review critics' (Step 6), may also write to a temporary directory created with `mktemp -d`; the change files still go only under `<change-dir>`. Action words in the request ("rename X", "try the fix") describe what the spec should plan, not something to do now.
14
14
  >
15
15
  > Do **not** suggest entering plan mode — its approval step is a "start coding" trigger that collapses scaffolding into implementation.
16
16
 
@@ -30,7 +30,16 @@ Run `theway path` and use the folder it prints as `<home>`: TheWay files are sto
30
30
  Read these files from `<home>`:
31
31
  - `<home>/config.yaml` - Global config and conventions
32
32
  - `<home>/data/standards/tamm-framework.md` - TAMM framework
33
- - `<home>/data/standards/architecture-principles.md` - SRE-EE principles (if enabled in config)
33
+ - `<home>/data/standards/core-principles.md` - Architecture philosophy (only when `standards.core_principles.enabled` is `true`)
34
+ - `<home>/data/standards/sre.md` - SRE operational excellence (only when `standards.sre.enabled` is `true`)
35
+ - `<home>/data/standards/web-development.md` - Web development standards (only when `standards.web_development.enabled` is `true`)
36
+ - `<home>/data/standards/quality.md` - Quality expectations (only when `standards.quality.enabled` is `true`)
37
+
38
+ An opt-in standard is read only when its `enabled` is the boolean `true`; an absent entry or any other value means off.
39
+
40
+ From `<home>/config.yaml`, take `engineering.review_rounds` (maximum review rounds in Step 6, default `1`). A key that is absent or not a non-negative integer takes the default.
41
+
42
+ Also take the critic model from `engineering.models.critic` (default `opus`). It must be `opus` or `sonnet`; a key that is absent or holds any other value takes the default.
34
43
 
35
44
  ### Step 2: Create Change Folder
36
45
 
@@ -79,6 +88,47 @@ If needed, create `<change-dir>/design.md` for:
79
88
  - Architecture decisions
80
89
  - Technical diagrams and specs
81
90
 
91
+ ### Step 6: Review
92
+
93
+ Check that the change can be implemented without guessing, before it is reported ready. Run this step only when Steps 3-5 left no open question; an open point recorded in the spec counts as one. Otherwise do not run it: the spec is not ready, and the Exit report says the review was not run. With `review_rounds: 0`, skip this step.
94
+
95
+ Run up to `review_rounds` review rounds. In a series, each round covers every member together.
96
+
97
+ Each round:
98
+
99
+ 1. **Review.** Spawn two critic agents in parallel, in a single message, with the Agent tool and `model` set to `engineering.models.critic` (never `haiku`). Neither sees the other's findings.
100
+ - **Grounding critic:** checks every claim of the spec about the code, tools, providers and libraries. It reads the code and official docs and may run single-question probes. It reports claims that are wrong, unverified or contradicted by the current code.
101
+ - **Implementability critic:** checks whether a cold-start implementer could carry out the change without guessing. It reports:
102
+ - choices left open ("probe X then decide", "A or B", "if needed");
103
+ - Success Criteria that cannot be checked, or whose check passes whatever the code does;
104
+ - Success Criteria with no task behind them, and tasks with no Success Criterion;
105
+ - tasks outside the Scope or listed as Out of Scope;
106
+ - tasks that cannot be done as written (a missing file, a command that does not exist, an environment the task assumes);
107
+ - contradictions between the spec and its tasks, or with the existing command, config or doc text the change touches;
108
+ - in a series, gaps and overlaps between members.
109
+
110
+ Each critic's prompt states:
111
+ - its lens and the finding format below;
112
+ - the absolute paths of `<change-dir>` (every member's folder in a series) and of the repository root. The critic finds the code and docs itself, from what the spec names; the standards and templates under `<home>` are not part of the prompt;
113
+ - the rules: it never edits the change folder or the repository; it writes no prototype, reproduces none of the planned code, config or schema, and does not re-implement the spec's rules to measure them; each probe answers exactly one question (a version, a behavior, an error string) and writes only to a temporary directory created with `mktemp -d`.
114
+
115
+ Each finding names the file (`spec.md`, `tasks.md` or `design.md`, plus the change ID in a series), the section or task number, a short quote, the problem, its evidence (a file and line, a doc URL, or a probe with its result) and a `kind`: `fixable` (the spec can be corrected from facts) or `decision` (only the user can settle it). The critic's `kind` is a proposal; you set the final `kind` when you verify the finding.
116
+ 2. **Triage findings**, once per round: number the round's findings `0..N-1` in the order reported, the grounding critic's first, and verify each one against the code, the docs or a single-question probe. Each gets one verdict: `confirmed` (real), `false_positive` (refuted), `duplicate` (the same problem as an earlier finding of the round, which it names), `nit` (real, cosmetic) or `out_of_scope` (not this change's). Change a proposed `decision` to `fixable` only when the code, the docs or the change's own stated decisions determine the answer; its verdict reads `confirmed, settled`.
117
+ 3. **Fix.** First edit the change files for every confirmed `fixable` finding of the round, keeping them to the template structure. Then, if the round has a confirmed `decision` finding, end the step: each one is an open question, and the spec is not ready.
118
+
119
+ A round with no confirmed findings ends the step. Otherwise start the next round only while rounds remain under `review_rounds`; the next round reviews the updated files. Your fixes are not re-checked unless another round runs.
120
+
121
+ If the Agent tool is not available in the session, run both lenses yourself, one after the other, under the same rules, and say in the Exit report that the review ran inline.
122
+
82
123
  ## Exit
83
124
 
84
- Report the change folder, the findings that shaped the spec, and any question still open. If a question is open, say so and stop; the spec is not ready until it is answered.
125
+ Report the change folder, the findings that shaped the spec, the review outcome below, and any question still open. A confirmed `decision` finding of Step 6 is an open question. If a question is open, stop after this report; the spec is not ready until it is answered.
126
+
127
+ The review outcome:
128
+ - how it ran: the rounds used, off (`review_rounds: 0`), not run because a question was already open, or inline;
129
+ - every finding of every round in one Markdown table with the columns `#`, `Finding`, `Verdict` and `Fix`, one row per finding:
130
+ - `#` is the round and the triage index, as `R<round>-<index>`, for example `R1-0`;
131
+ - `Finding` is one line saying what is wrong;
132
+ - `Verdict` is the triage verdict, or `confirmed, settled` for a proposed `decision` you settled as `fixable`;
133
+ - `Fix` says how the change files changed for a confirmed `fixable` finding, reads `open question:` followed by the question for a confirmed `decision`, names the earlier `#` for a `duplicate`, and gives the one-line reason for the other verdicts;
134
+ - under the table, each `confirmed, settled` finding again, with the choice made, so the user can overturn it.
@@ -2,7 +2,7 @@
2
2
  description: Install or update theway from a Claude Code session
3
3
  author: Amine
4
4
  # x-release-please-start-version
5
- allowed-tools: Bash(npx --yes @pixelfactoryio/theway@0.5.3 install)
5
+ allowed-tools: Bash(npx --yes @pixelfactoryio/theway@0.6.0 install)
6
6
  # x-release-please-end
7
7
  ---
8
8
 
@@ -16,7 +16,7 @@ One-time setup: installs the `theway` CLI on your `PATH` and initializes the the
16
16
 
17
17
  <!-- x-release-please-start-version -->
18
18
  ```bash
19
- npx --yes @pixelfactoryio/theway@0.5.3 install
19
+ npx --yes @pixelfactoryio/theway@0.6.0 install
20
20
  ```
21
21
  <!-- x-release-please-end -->
22
22
 
@@ -161,7 +161,6 @@ docs/architecture/
161
161
  - Plugin's `config.yaml` - Template registry and configuration
162
162
  - Plugin's `project.md` - TheWay methodology conventions
163
163
  - Plugin's `data/standards/tamm-framework.md` - TAMM framework details
164
- - Plugin's `data/standards/architecture-principles.md` - SRE-EE principles
165
164
  - Plugin's `templates/*.md` - Template files with frontmatter instructions
166
165
  - Plugin's `commands/*.md` - Slash command definitions
167
166
 
@@ -1,7 +1,7 @@
1
1
  # theway configuration
2
2
  # <home> is the theway home, the folder `theway path` prints
3
3
 
4
- # Standards read by the commands; only `architecture` honors `enabled`
4
+ # Standards read by the commands; core_principles, sre, web_development and quality are opt-in and honor enabled, the others are always read
5
5
  standards:
6
6
  interaction:
7
7
  enabled: true
@@ -13,10 +13,25 @@ standards:
13
13
  file: "<home>/data/standards/develop.md"
14
14
  description: "How a change is implemented and verified, shared by /theway:develop and /theway:develop-workflow"
15
15
 
16
- architecture:
17
- enabled: true
18
- file: "<home>/data/standards/architecture-principles.md"
19
- description: "SRE-EE architecture principles and web development standards"
16
+ core_principles:
17
+ enabled: false
18
+ file: "<home>/data/standards/core-principles.md"
19
+ description: "Opt-in: architecture philosophy (simplicity, security, pragmatic technology)"
20
+
21
+ sre:
22
+ enabled: false
23
+ file: "<home>/data/standards/sre.md"
24
+ description: "Opt-in: SRE operational excellence (reliability, observability, automation)"
25
+
26
+ web_development:
27
+ enabled: false
28
+ file: "<home>/data/standards/web-development.md"
29
+ description: "Opt-in: frontend, API and backend standards with web performance targets"
30
+
31
+ quality:
32
+ enabled: false
33
+ file: "<home>/data/standards/quality.md"
34
+ description: "Opt-in: testing, deployment, monitoring and security expectations"
20
35
 
21
36
  tamm_framework:
22
37
  enabled: true
@@ -44,6 +59,15 @@ changes:
44
59
  optional_files:
45
60
  - design.md
46
61
 
62
+ # Engineering - spec review for /theway:engineering (absent or invalid key means the default)
63
+ engineering:
64
+ # Maximum review rounds per scaffold; 0 skips the review
65
+ review_rounds: 1
66
+ # Model of the two critic agents: opus or sonnet (absent or invalid means the default)
67
+ # Lower cost: sonnet
68
+ models:
69
+ critic: opus
70
+
47
71
  # Develop Workflow - caps for /theway:develop-workflow (absent or invalid key means the default)
48
72
  workflow:
49
73
  # Review rounds per change; 0 skips review and the fix check
@@ -0,0 +1,10 @@
1
+ # Core Principles
2
+
3
+ - Progressive Complexity - Start simple, scale when needed
4
+ - Security at Every Layer - Defense in depth
5
+ - User Experience Drives Architecture - Start with journeys, work backward
6
+ - Pragmatic Technology - Boring tech where possible, exciting when necessary
7
+ - Cost-Conscious Engineering - Balance ideals with reality
8
+ - Data-Centric Design - Let data requirements drive architecture
9
+
10
+ Apply these pragmatically based on project context.
@@ -0,0 +1,8 @@
1
+ # Quality Standards
2
+
3
+ **Testing:** Unit tests, integration tests, end-to-end tests, load tests
4
+ **Deployment:** CI/CD, feature flags, rollback plans
5
+ **Monitoring:** Structured logs, metrics, tracing, actionable alerts
6
+ **Security:** Authentication, authorization, encryption, input validation, least privilege
7
+
8
+ Apply these pragmatically based on project context.
@@ -0,0 +1,13 @@
1
+ # SRE-EE Operational Excellence
2
+
3
+ - Reliability First - Design stable, resilient systems
4
+ - Observability - Make systems transparent and measurable
5
+ - Maintainability - Build systems easy to change and evolve
6
+ - Self-Service - Enable team independence
7
+ - Automation - Reduce manual intervention
8
+
9
+ ## Applying
10
+
11
+ - `/theway:document`: write `coding-standards.md` and `tech-stack.md` following SRE-EE operational excellence principles
12
+
13
+ Apply these pragmatically based on project context.
@@ -0,0 +1,27 @@
1
+ # Web Development Standards
2
+
3
+ **Frontend:**
4
+ - Component-based architecture
5
+ - Desktop-first for internal tools
6
+ - Performance: <2s initial load, <500ms navigation
7
+ - Low cognitive load, consistent patterns
8
+
9
+ **API Design:**
10
+ - Resource-based URLs: `/api/v1/services/{id}`
11
+ - Correct HTTP verbs: GET (read), POST (create), PUT (update), DELETE (remove)
12
+ - Consistent response formats
13
+ - OpenAPI/Swagger documentation
14
+
15
+ **Backend:**
16
+ - Single Responsibility - One clear purpose per service
17
+ - Loose Coupling - Minimize service dependencies
18
+ - Stateless Where Possible - Simplify scaling
19
+ - Infrastructure as Code - Version all infrastructure
20
+
21
+ **Performance Targets:** API <200ms (p95), pages <2s initial/<500ms nav, DB <100ms (p95)
22
+
23
+ ## Applying
24
+
25
+ - Specs cover frontend, backend, API, migrations and monitoring
26
+
27
+ Apply these pragmatically based on project context.
@@ -1,10 +1,10 @@
1
1
  ---
2
2
  template_type: "coding_standards"
3
3
  usage: "Document project-specific coding conventions when using /theway:document to fill documentation gaps"
4
- agent_role: "System Architect documenting coding standards following SRE-EE operational excellence principles"
4
+ agent_role: "System Architect documenting coding standards"
5
5
  required_context:
6
6
  - "<home>/config.yaml - Global config and conventions"
7
- - "<home>/data/standards/architecture-principles.md - SRE-EE principles (if enabled)"
7
+ - "<home>/data/standards/core-principles.md, sre.md, web-development.md, quality.md - Opt-in standards (each only if enabled)"
8
8
  - "Existing codebase - Review actual patterns and conventions in use"
9
9
  quality_standards:
10
10
  - "Conventions reflect actual codebase patterns (not aspirational)"
@@ -5,7 +5,7 @@ agent_role: "Spec Analyst who analyzes solutions using the TAMM framework (Time/
5
5
  required_context:
6
6
  - "<home>/config.yaml - Global config and conventions"
7
7
  - "<home>/data/standards/tamm-framework.md - TAMM framework"
8
- - "<home>/data/standards/architecture-principles.md - SRE-EE principles (if enabled)"
8
+ - "<home>/data/standards/core-principles.md, sre.md, web-development.md, quality.md - Opt-in standards (each only if enabled)"
9
9
  - "docs/architecture/coding-standards.md - Project coding standards (if exists)"
10
10
  quality_standards:
11
11
  - "TAMM table includes only Medium/High risk hardpoints (skip low-risk items)"
@@ -23,7 +23,7 @@ workflow_steps:
23
23
  - "6. Create measurable success criteria"
24
24
  best_practices:
25
25
  - "Challenge assumptions: 'What would we need for this to work?'"
26
- - "Ensure complete solution coverage: frontend, backend, API, migrations, monitoring"
26
+ - "Cover every part of the system the change touches"
27
27
  - "Consider edge cases, error scenarios, and operational concerns"
28
28
  - "Focus on medium/high-risk hardpoints only - skip low-risk items"
29
29
  - "Keep analysis practical and actionable, not verbose"
@@ -110,5 +110,3 @@ best_practices:
110
110
  - [ ] [Criterion 2]
111
111
  - [ ] [Criterion 3]
112
112
  - [ ] [Criterion 4]
113
-
114
- **Estimated Effort:** [Duration estimate]
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  template_type: "implementation_tasks"
3
3
  usage: "Create numbered implementation checklist when scaffolding a change with /theway:engineering"
4
- agent_role: "Full-stack developer who breaks down spec analysis into concrete, sequential implementation tasks"
4
+ agent_role: "Developer who breaks down spec analysis into concrete, sequential implementation tasks"
5
5
  required_context:
6
6
  - "<change-dir>/spec.md - Understand solution, scope, and hardpoints"
7
7
  - "<home>/config.yaml - Global config and conventions"
@@ -11,15 +11,13 @@ quality_standards:
11
11
  - "Each task has a checkbox [ ] for progress tracking"
12
12
  - "Tasks are organized by logical implementation phases"
13
13
  - "Tasks are specific and actionable (not vague)"
14
- - "Estimated time provided for each phase"
15
14
  - "Notes section captures blockers, discoveries, and adjustments"
16
15
  - "Tasks are only work done in the repository: no tasks for reviewing the spec, setting up the environment, branching, PRs, code review, merging or archiving (the commands do those)"
17
16
  workflow_steps:
18
17
  - "1. Review spec analysis to understand solution and phases"
19
18
  - "2. Break each phase into specific, sequential tasks"
20
19
  - "3. Number all tasks consecutively across phases"
21
- - "4. Estimate time for each phase realistically"
22
- - "5. Include testing and documentation tasks"
20
+ - "4. Choose the phases from the change itself: the template prescribes none. Add a documentation task only when the change affects documentation"
23
21
  best_practices:
24
22
  - "Work sequentially through tasks in order"
25
23
  - "Check off tasks immediately after completion"
@@ -31,48 +29,16 @@ best_practices:
31
29
 
32
30
  # Implementation Tasks: [Change Name]
33
31
 
34
- ## Overview
35
-
36
- **Total Estimated Effort:** [Time estimate]
37
- **Target Completion:** [Date]
38
-
39
- ## Phase 1: [Core Implementation Phase Name]
40
-
41
- **Estimated Time:** [Duration]
32
+ ## Phase 1: [Phase Name]
42
33
 
43
34
  - [ ] 1. [Specific implementation task]
44
35
  - [ ] 2. [Specific implementation task]
45
36
  - [ ] 3. [Specific implementation task]
46
- - [ ] 4. [Specific implementation task]
47
- - [ ] 5. [Specific implementation task]
48
-
49
- ## Phase 2: [Secondary Implementation Phase Name]
50
-
51
- **Estimated Time:** [Duration]
52
37
 
53
- - [ ] 6. [Specific implementation task]
54
- - [ ] 7. [Specific implementation task]
55
- - [ ] 8. [Specific implementation task]
56
- - [ ] 9. [Specific implementation task]
38
+ ## Phase 2: [Phase Name]
57
39
 
58
- ## Phase 3: Testing
59
-
60
- **Estimated Time:** [Duration]
61
-
62
- - [ ] 10. Write unit tests for [component]
63
- - [ ] 11. Write integration tests for [flow]
64
- - [ ] 12. Add end-to-end tests for [scenario]
65
- - [ ] 13. Test error scenarios and edge cases
66
- - [ ] 14. Verify performance requirements
67
- - [ ] 15. Manual testing and validation
68
-
69
- ## Phase 4: Documentation
70
-
71
- **Estimated Time:** [Duration]
72
-
73
- - [ ] 16. Update API documentation
74
- - [ ] 17. Update architecture docs (if needed)
75
- - [ ] 18. Update README/user docs
40
+ - [ ] 4. [Specific implementation task]
41
+ - [ ] 5. [Specific implementation task]
76
42
 
77
43
  ## Notes
78
44
 
@@ -1,26 +1,26 @@
1
1
  ---
2
2
  template_type: "tech_stack"
3
3
  usage: "Document technology choices, dependencies, and rationale when using /theway:document to fill documentation gaps"
4
- agent_role: "System Architect documenting technology stack decisions following SRE-EE principles"
4
+ agent_role: "System Architect documenting technology stack decisions"
5
5
  required_context:
6
6
  - "<home>/config.yaml - Global config and conventions"
7
- - "<home>/data/standards/architecture-principles.md - SRE-EE principles (if enabled)"
7
+ - "<home>/data/standards/core-principles.md, sre.md, web-development.md, quality.md - Opt-in standards (each only if enabled)"
8
8
  - "Package files (package.json, requirements.txt, go.mod, etc.) - Actual dependencies"
9
- - "Infrastructure configs (terraform, k8s manifests) - Deployment tech"
9
+ - "Infrastructure configs (terraform, k8s manifests), if any - Deployment tech"
10
10
  quality_standards:
11
- - "Technology stack table includes version, purpose, and rationale"
11
+ - "Technology stack table includes version, purpose, and rationale, with a row only for each category the repository uses"
12
12
  - "Core dependencies list is accurate from package files"
13
13
  - "Technical decisions explain trade-offs and alternatives considered"
14
- - "Infrastructure and deployment tools are documented"
14
+ - "Infrastructure and deployment tools are documented when the repository has them"
15
15
  - "Version constraints reflect actual compatibility requirements"
16
16
  - "Migration notes capture historical context"
17
17
  - "Rationales explain WHY choices were made, not just WHAT"
18
18
  workflow_steps:
19
19
  - "1. Review package files to identify all dependencies"
20
- - "2. Document cloud provider and key services in use"
20
+ - "2. Document cloud provider and key services in use, if any"
21
21
  - "3. Create technology stack table with versions and rationales"
22
22
  - "4. List core dependencies with their purposes"
23
- - "5. Document development tools and infrastructure setup"
23
+ - "5. Document development tools, and the infrastructure setup if any"
24
24
  - "6. Capture technical decisions with trade-offs"
25
25
  - "7. Add version constraints and update policies"
26
26
  best_practices:
@@ -30,6 +30,7 @@ best_practices:
30
30
  - "Update when major dependencies change"
31
31
  - "Reference ADRs (Architecture Decision Records) if they exist"
32
32
  - "Keep rationales concise but informative"
33
+ - "Write only the sections and table rows the repository shows evidence for (package files, IaC, deploy configs); omit the others"
33
34
  ---
34
35
 
35
36
  # Tech Stack
@@ -39,6 +40,7 @@ best_practices:
39
40
  Technology choices, dependencies, and rationale for {{PROJECT_NAME}}.
40
41
 
41
42
  ## Cloud Infrastructure
43
+ [Omit this section if the repository has none.]
42
44
 
43
45
  - **Provider:** {{CLOUD_PROVIDER}}
44
46
  - **Key Services:** {{CORE_SERVICES}}
@@ -82,6 +84,7 @@ Technology choices, dependencies, and rationale for {{PROJECT_NAME}}.
82
84
  - **Local Development:** {{LOCAL_DEV_TOOLS}}
83
85
 
84
86
  ## Infrastructure & Deployment
87
+ [Omit this section if the repository has none.]
85
88
 
86
89
  ### Deployment Tools
87
90
  - **Container Runtime:** {{CONTAINER_RUNTIME}} {{VERSION}}
@@ -94,6 +97,7 @@ Technology choices, dependencies, and rationale for {{PROJECT_NAME}}.
94
97
  - **Module Structure:** {{MODULE_STRUCTURE}}
95
98
 
96
99
  ## Database & Storage
100
+ [Omit this section if the repository has none.]
97
101
 
98
102
  ### Primary Database
99
103
  - **Type:** {{DB_TYPE}}
@@ -107,6 +111,7 @@ Technology choices, dependencies, and rationale for {{PROJECT_NAME}}.
107
111
  - **Cache:** {{CACHE_SOLUTION}} {{VERSION}}
108
112
 
109
113
  ## Monitoring & Observability
114
+ [Omit this section if the repository has none.]
110
115
 
111
116
  - **Metrics:** {{METRICS_PLATFORM}}
112
117
  - **Logging:** {{LOGGING_PLATFORM}}
@@ -114,6 +119,7 @@ Technology choices, dependencies, and rationale for {{PROJECT_NAME}}.
114
119
  - **Alerting:** {{ALERTING_PLATFORM}}
115
120
 
116
121
  ## Security Tools
122
+ [Omit this section if the repository has none.]
117
123
 
118
124
  - **Secrets Management:** {{SECRETS_TOOL}}
119
125
  - **Authentication:** {{AUTH_METHOD}}
@@ -1,50 +0,0 @@
1
- # SRE-EE Architecture Principles
2
-
3
- ## Core Principles
4
-
5
- **Operational Excellence:**
6
- - Reliability First - Design stable, resilient systems
7
- - Observability - Make systems transparent and measurable
8
- - Maintainability - Build systems easy to change and evolve
9
- - Self-Service - Enable team independence
10
- - Automation - Reduce manual intervention
11
-
12
- **Architecture Philosophy:**
13
- - Progressive Complexity - Start simple, scale when needed
14
- - Security at Every Layer - Defense in depth
15
- - User Experience Drives Architecture - Start with journeys, work backward
16
- - Pragmatic Technology - Boring tech where possible, exciting when necessary
17
- - Cost-Conscious Engineering - Balance ideals with reality
18
- - Data-Centric Design - Let data requirements drive architecture
19
-
20
- ## Web Development Standards
21
-
22
- **Frontend:**
23
- - Component-based architecture
24
- - Desktop-first for internal tools
25
- - Performance: <2s initial load, <500ms navigation
26
- - Low cognitive load, consistent patterns
27
-
28
- **API Design:**
29
- - Resource-based URLs: `/api/v1/services/{id}`
30
- - Correct HTTP verbs: GET (read), POST (create), PUT (update), DELETE (remove)
31
- - Consistent response formats
32
- - OpenAPI/Swagger documentation
33
-
34
- **Backend:**
35
- - Single Responsibility - One clear purpose per service
36
- - Loose Coupling - Minimize service dependencies
37
- - Stateless Where Possible - Simplify scaling
38
- - Infrastructure as Code - Version all infrastructure
39
-
40
- ## Quality Standards
41
-
42
- **Testing:** Unit tests, integration tests, end-to-end tests, load tests
43
- **Deployment:** CI/CD, feature flags, rollback plans
44
- **Monitoring:** Structured logs, metrics, tracing, actionable alerts
45
- **Security:** Authentication, authorization, encryption, input validation, least privilege
46
- **Performance Targets:** API <200ms (p95), pages <2s initial/<500ms nav, DB <100ms (p95)
47
-
48
- ## References
49
-
50
- Apply principles pragmatically based on project context. Update as practices evolve.