@enki-dev-expert/global-engineering-standards 0.0.0-stage → 0.1.1

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.
Files changed (51) hide show
  1. package/AGENTS.md +303 -0
  2. package/CHANGELOG.md +28 -0
  3. package/CITATION.cff +21 -0
  4. package/CODE_OF_CONDUCT.md +13 -0
  5. package/CONTRIBUTING.md +27 -0
  6. package/LICENSE +21 -0
  7. package/README.md +159 -2
  8. package/SECURITY.md +25 -0
  9. package/dist/cli.js +40 -0
  10. package/dist/content.js +71 -0
  11. package/dist/filesystem.js +83 -0
  12. package/dist/installer.js +243 -0
  13. package/dist/layout.js +42 -0
  14. package/dist/transaction.js +143 -0
  15. package/docs/ai-and-llm.md +1312 -0
  16. package/docs/architecture.md +1007 -0
  17. package/docs/cost-engineering.md +1322 -0
  18. package/docs/data.md +993 -0
  19. package/docs/governance.md +1744 -0
  20. package/docs/mobile-and-web.md +1362 -0
  21. package/docs/observability.md +1345 -0
  22. package/docs/platforms-and-applications.md +1581 -0
  23. package/docs/privacy.md +566 -0
  24. package/docs/quality-and-testing.md +1278 -0
  25. package/docs/scalability.md +1012 -0
  26. package/docs/security.md +373 -0
  27. package/handbook/claude-plugin.md +31 -0
  28. package/handbook/compatibility.md +27 -0
  29. package/handbook/recovery.md +29 -0
  30. package/handbook/releasing.md +50 -0
  31. package/handbook/security-review.md +41 -0
  32. package/handbook/signing.md +18 -0
  33. package/handbook/validation.md +50 -0
  34. package/package.json +65 -4
  35. package/scripts/content-baseline.json +25 -0
  36. package/skills/engineering-architecture-review/SKILL.md +1531 -0
  37. package/skills/engineering-cost-estimate/SKILL.md +1599 -0
  38. package/skills/engineering-database-review/SKILL.md +1364 -0
  39. package/skills/engineering-privacy-check/SKILL.md +1295 -0
  40. package/skills/engineering-safe-implementation/SKILL.md +1502 -0
  41. package/skills/engineering-security-standards-check/SKILL.md +1112 -0
  42. package/src/cli.ts +45 -0
  43. package/src/content.ts +82 -0
  44. package/src/filesystem.ts +94 -0
  45. package/src/installer.ts +280 -0
  46. package/src/layout.ts +70 -0
  47. package/src/transaction.ts +167 -0
  48. package/templates/ADR.md +1302 -0
  49. package/templates/AUDIT_REPORT.md +1693 -0
  50. package/templates/EXCEPTIONS.md +647 -0
  51. package/templates/PROJECT_AGENTS.md +868 -0
@@ -0,0 +1,1302 @@
1
+
2
+ # Architecture Decision Record (ADR)
3
+
4
+ ## 1. Purpose
5
+
6
+ Document significant software architecture and technical decisions.
7
+
8
+ This template is part of the Global Engineering Standards framework:
9
+
10
+ ~/engineering-standards/
11
+
12
+ Architecture Decision Records provide traceability for:
13
+
14
+ - Technology selection.
15
+ - Architectural patterns.
16
+ - Data architecture.
17
+ - Infrastructure decisions.
18
+ - Security architecture.
19
+ - AI system design.
20
+ - Scalability strategies.
21
+ - Reliability decisions.
22
+ - Integration approaches.
23
+ - Significant technical migrations.
24
+
25
+ This is a reusable template, not an approved decision.
26
+
27
+ Replace all placeholders with verified project-specific information.
28
+
29
+ Do not fabricate evaluations, benchmarks, pricing or approvals.
30
+
31
+ ## 2. ADR Identification
32
+
33
+ ADR ID:
34
+
35
+ [ADR-0001]
36
+
37
+ Title:
38
+
39
+ [SHORT_DECISION_TITLE]
40
+
41
+ Project:
42
+
43
+ [PROJECT_NAME]
44
+
45
+ Repository:
46
+
47
+ [REPOSITORY_PATH]
48
+
49
+ Decision status:
50
+
51
+ [PROPOSED | ACCEPTED | REJECTED | SUPERSEDED | DEPRECATED]
52
+
53
+ Created:
54
+
55
+ [YYYY-MM-DD]
56
+
57
+ Last reviewed:
58
+
59
+ [YYYY-MM-DD_OR_NOT_REVIEWED]
60
+
61
+ Decision owner:
62
+
63
+ [PERSON_OR_ROLE]
64
+
65
+ Related ADRs:
66
+
67
+ [RELATED_ADRS_OR_NONE]
68
+
69
+ Related requirements:
70
+
71
+ [REQUIREMENT_REFERENCES]
72
+
73
+ ## 3. Decision Summary
74
+
75
+ Summarize the decision in clear language.
76
+
77
+ Decision:
78
+
79
+ [DECISION_SUMMARY]
80
+
81
+ Primary reason:
82
+
83
+ [PRIMARY_JUSTIFICATION]
84
+
85
+ Expected benefit:
86
+
87
+ [EXPECTED_BENEFIT]
88
+
89
+ Important limitation:
90
+
91
+ [IMPORTANT_LIMITATION]
92
+
93
+ Keep this section concise and understandable.
94
+
95
+ ## 4. Business Context
96
+
97
+ Describe the actual problem.
98
+
99
+ Business objective:
100
+
101
+ [BUSINESS_OBJECTIVE]
102
+
103
+ Target users:
104
+
105
+ [TARGET_USERS]
106
+
107
+ Required functionality:
108
+
109
+ [REQUIRED_FUNCTIONALITY]
110
+
111
+ Operational context:
112
+
113
+ [OPERATIONAL_CONTEXT]
114
+
115
+ Current constraints:
116
+
117
+ [CONSTRAINTS]
118
+
119
+ Do not choose architecture based only on technology trends.
120
+
121
+ ## 5. Technical Context
122
+
123
+ Existing technologies:
124
+
125
+ [EXISTING_STACK]
126
+
127
+ Current architecture:
128
+
129
+ [CURRENT_ARCHITECTURE]
130
+
131
+ Relevant integrations:
132
+
133
+ [INTEGRATIONS]
134
+
135
+ Current data architecture:
136
+
137
+ [DATA_ARCHITECTURE]
138
+
139
+ Deployment environment:
140
+
141
+ [ENVIRONMENT]
142
+
143
+ Known limitations:
144
+
145
+ [VERIFIED_LIMITATIONS]
146
+
147
+ For existing applications, inspect the implementation before proposing replacement technologies.
148
+
149
+ For new applications, document the assumptions used in the evaluation.
150
+
151
+ ## 6. Decision Drivers
152
+
153
+ Identify the factors that influence the decision.
154
+
155
+ Possible drivers:
156
+
157
+ - Security.
158
+ - Privacy.
159
+ - Data integrity.
160
+ - Scalability.
161
+ - Performance.
162
+ - Reliability.
163
+ - Availability.
164
+ - Developer productivity.
165
+ - Maintainability.
166
+ - Portability.
167
+ - Operational complexity.
168
+ - Vendor dependency.
169
+ - Compliance.
170
+ - Cost.
171
+ - Time to market.
172
+ - Team expertise.
173
+ - Platform compatibility.
174
+
175
+ Actual project priorities:
176
+
177
+ [PRIORITIZED_DECISION_DRIVERS]
178
+
179
+ Distinguish mandatory requirements from preferences.
180
+
181
+ ## 7. Functional Requirements
182
+
183
+ Required behavior:
184
+
185
+ [FUNCTIONAL_REQUIREMENTS]
186
+
187
+ Important workflows:
188
+
189
+ [CRITICAL_WORKFLOWS]
190
+
191
+ Integration requirements:
192
+
193
+ [INTEGRATION_REQUIREMENTS]
194
+
195
+ Acceptance criteria:
196
+
197
+ [ACCEPTANCE_CRITERIA]
198
+
199
+ Do not invent requirements not supplied or supported by verified project context.
200
+
201
+ ## 8. Non-Functional Requirements
202
+
203
+ Document relevant measurable requirements.
204
+
205
+ Security:
206
+
207
+ [SECURITY_REQUIREMENTS]
208
+
209
+ Privacy:
210
+
211
+ [PRIVACY_REQUIREMENTS]
212
+
213
+ Availability:
214
+
215
+ [AVAILABILITY_REQUIREMENTS]
216
+
217
+ Latency:
218
+
219
+ [LATENCY_REQUIREMENTS]
220
+
221
+ Throughput:
222
+
223
+ [THROUGHPUT_REQUIREMENTS]
224
+
225
+ Concurrency:
226
+
227
+ [CONCURRENCY_REQUIREMENTS]
228
+
229
+ Data volume:
230
+
231
+ [DATA_VOLUME]
232
+
233
+ Recovery requirements:
234
+
235
+ [RECOVERY_REQUIREMENTS]
236
+
237
+ Portability:
238
+
239
+ [PORTABILITY_REQUIREMENTS]
240
+
241
+ Cost constraints:
242
+
243
+ [COST_CONSTRAINTS]
244
+
245
+ Unknown values must remain explicitly unknown.
246
+
247
+ Do not present targets as measured performance.
248
+
249
+ ## 9. Current-State Evidence
250
+
251
+ Evidence reviewed:
252
+
253
+ [EVIDENCE_REFERENCES]
254
+
255
+ Measured metrics:
256
+
257
+ [MEASURED_METRICS_OR_NONE]
258
+
259
+ Observed problems:
260
+
261
+ [CONFIRMED_PROBLEMS_OR_NONE]
262
+
263
+ Assumptions:
264
+
265
+ [EXPLICIT_ASSUMPTIONS]
266
+
267
+ Confidence:
268
+
269
+ [HIGH | MEDIUM | LOW]
270
+
271
+ Separate observed facts from estimates and hypotheses.
272
+
273
+ ## 10. Options Considered
274
+
275
+ Evaluate reasonable alternatives.
276
+
277
+ Do not manufacture alternatives merely to justify a preferred solution.
278
+
279
+ ### Option A
280
+
281
+ Name:
282
+
283
+ [OPTION_A_NAME]
284
+
285
+ Description:
286
+
287
+ [OPTION_A_DESCRIPTION]
288
+
289
+ Advantages:
290
+
291
+ [OPTION_A_ADVANTAGES]
292
+
293
+ Disadvantages:
294
+
295
+ [OPTION_A_DISADVANTAGES]
296
+
297
+ Security implications:
298
+
299
+ [OPTION_A_SECURITY]
300
+
301
+ Scalability implications:
302
+
303
+ [OPTION_A_SCALABILITY]
304
+
305
+ Operational implications:
306
+
307
+ [OPTION_A_OPERATIONS]
308
+
309
+ Cost considerations:
310
+
311
+ [OPTION_A_COST]
312
+
313
+ ### Option B
314
+
315
+ Name:
316
+
317
+ [OPTION_B_NAME]
318
+
319
+ Description:
320
+
321
+ [OPTION_B_DESCRIPTION]
322
+
323
+ Advantages:
324
+
325
+ [OPTION_B_ADVANTAGES]
326
+
327
+ Disadvantages:
328
+
329
+ [OPTION_B_DISADVANTAGES]
330
+
331
+ Security implications:
332
+
333
+ [OPTION_B_SECURITY]
334
+
335
+ Scalability implications:
336
+
337
+ [OPTION_B_SCALABILITY]
338
+
339
+ Operational implications:
340
+
341
+ [OPTION_B_OPERATIONS]
342
+
343
+ Cost considerations:
344
+
345
+ [OPTION_B_COST]
346
+
347
+ ### Option C — Optional
348
+
349
+ Name:
350
+
351
+ [OPTION_C_NAME_OR_NOT_APPLICABLE]
352
+
353
+ Description:
354
+
355
+ [OPTION_C_DESCRIPTION]
356
+
357
+ Advantages:
358
+
359
+ [OPTION_C_ADVANTAGES]
360
+
361
+ Disadvantages:
362
+
363
+ [OPTION_C_DISADVANTAGES]
364
+
365
+ Cost considerations:
366
+
367
+ [OPTION_C_COST]
368
+
369
+ Include only meaningful alternatives.
370
+
371
+ ## 11. Comparative Evaluation
372
+
373
+ Summarize the trade-offs.
374
+
375
+ | Criterion | Option A | Option B | Option C |
376
+ |---|---|---|---|
377
+ | Security | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
378
+ | Privacy | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
379
+ | Data integrity | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
380
+ | Scalability | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
381
+ | Performance | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
382
+ | Reliability | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
383
+ | Maintainability | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
384
+ | Cost | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
385
+ | Complexity | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
386
+ | Portability | [ASSESSMENT] | [ASSESSMENT] | [ASSESSMENT] |
387
+
388
+ Remove irrelevant columns and criteria when completing an actual ADR.
389
+
390
+ Do not assign numerical scores without a defensible methodology.
391
+
392
+ ## 12. Selected Decision
393
+
394
+ Selected option:
395
+
396
+ [SELECTED_OPTION]
397
+
398
+ Detailed decision:
399
+
400
+ [DECISION_DETAILS]
401
+
402
+ Why selected:
403
+
404
+ [DECISION_RATIONALE]
405
+
406
+ Why alternatives were not selected:
407
+
408
+ [ALTERNATIVE_REJECTION_REASONS]
409
+
410
+ Important assumptions:
411
+
412
+ [ASSUMPTIONS]
413
+
414
+ Document the actual trade-offs.
415
+
416
+ ## 13. Architectural Structure
417
+
418
+ Describe the resulting architecture.
419
+
420
+ Main components:
421
+
422
+ [COMPONENTS]
423
+
424
+ Responsibilities:
425
+
426
+ [RESPONSIBILITIES]
427
+
428
+ Communication patterns:
429
+
430
+ [COMMUNICATION_PATTERNS]
431
+
432
+ Data flow:
433
+
434
+ [DATA_FLOW]
435
+
436
+ External dependencies:
437
+
438
+ [DEPENDENCIES]
439
+
440
+ Trust boundaries:
441
+
442
+ [TRUST_BOUNDARIES]
443
+
444
+ Diagram or reference:
445
+
446
+ [DIAGRAM_REFERENCE_OR_NONE]
447
+
448
+ Keep the architecture as simple as reasonably possible.
449
+
450
+ Consult docs/architecture.md.
451
+
452
+ ## 14. Security Impact
453
+
454
+ Assess:
455
+
456
+ - Authentication.
457
+ - Authorization.
458
+ - Input validation.
459
+ - Data isolation.
460
+ - Secret management.
461
+ - Dependency security.
462
+ - Network exposure.
463
+ - Supply chain risk.
464
+ - Privileged operations.
465
+ - Auditability.
466
+
467
+ Security consequences:
468
+
469
+ [SECURITY_CONSEQUENCES]
470
+
471
+ New attack surfaces:
472
+
473
+ [ATTACK_SURFACES]
474
+
475
+ Required controls:
476
+
477
+ [REQUIRED_CONTROLS]
478
+
479
+ Residual risks:
480
+
481
+ [RESIDUAL_RISKS]
482
+
483
+ Consult docs/security.md.
484
+
485
+ ## 15. Privacy and Compliance Impact
486
+
487
+ Personal data involved:
488
+
489
+ [PERSONAL_DATA]
490
+
491
+ Data processing purposes:
492
+
493
+ [PROCESSING_PURPOSES]
494
+
495
+ Data minimization implications:
496
+
497
+ [DATA_MINIMIZATION]
498
+
499
+ Relevant providers or processors:
500
+
501
+ [PROCESSORS]
502
+
503
+ International transfer considerations:
504
+
505
+ [TRANSFERS]
506
+
507
+ Data retention implications:
508
+
509
+ [RETENTION]
510
+
511
+ Relevant verified legal requirements:
512
+
513
+ [LEGAL_REQUIREMENTS]
514
+
515
+ Unresolved compliance questions:
516
+
517
+ [OPEN_COMPLIANCE_QUESTIONS]
518
+
519
+ Do not claim legal compliance solely because a technology supports particular controls.
520
+
521
+ Consult docs/privacy.md.
522
+
523
+ ## 16. Data Architecture Impact
524
+
525
+ Database changes:
526
+
527
+ [DATABASE_CHANGES]
528
+
529
+ Schema implications:
530
+
531
+ [SCHEMA_IMPLICATIONS]
532
+
533
+ Consistency requirements:
534
+
535
+ [CONSISTENCY_REQUIREMENTS]
536
+
537
+ Transaction boundaries:
538
+
539
+ [TRANSACTION_BOUNDARIES]
540
+
541
+ Tenant isolation:
542
+
543
+ [TENANCY_IMPACT]
544
+
545
+ Migration requirements:
546
+
547
+ [MIGRATION_REQUIREMENTS]
548
+
549
+ Backup implications:
550
+
551
+ [BACKUP_IMPACT]
552
+
553
+ Recovery implications:
554
+
555
+ [RECOVERY_IMPACT]
556
+
557
+ Protect data integrity.
558
+
559
+ Never treat an ADR as permission to execute destructive migrations.
560
+
561
+ Consult docs/data.md.
562
+
563
+ ## 17. Scalability Assessment
564
+
565
+ Current workload:
566
+
567
+ [ACTUAL_WORKLOAD_OR_UNKNOWN]
568
+
569
+ Expected growth:
570
+
571
+ [GROWTH_ASSUMPTIONS]
572
+
573
+ Peak concurrency:
574
+
575
+ [CONCURRENCY_OR_UNKNOWN]
576
+
577
+ Potential bottlenecks:
578
+
579
+ [BOTTLENECKS]
580
+
581
+ Scaling approach:
582
+
583
+ [SCALING_STRATEGY]
584
+
585
+ Capacity validation:
586
+
587
+ [VALIDATION_PLAN]
588
+
589
+ Design for an achievable evolution path toward large-scale use.
590
+
591
+ Do not confuse total registered users with concurrent users.
592
+
593
+ Do not claim support for millions of users without relevant evidence.
594
+
595
+ Consult docs/scalability.md.
596
+
597
+ ## 18. Performance Impact
598
+
599
+ Expected performance effects:
600
+
601
+ [EXPECTED_EFFECTS]
602
+
603
+ Relevant metrics:
604
+
605
+ [METRICS]
606
+
607
+ Measurement approach:
608
+
609
+ [MEASUREMENT_PLAN]
610
+
611
+ Performance risks:
612
+
613
+ [PERFORMANCE_RISKS]
614
+
615
+ Optimization opportunities:
616
+
617
+ [OPTIMIZATION_OPPORTUNITIES]
618
+
619
+ Distinguish estimates from measurements.
620
+
621
+ Avoid premature optimization.
622
+
623
+ ## 19. Reliability and Availability
624
+
625
+ Failure modes:
626
+
627
+ [FAILURE_MODES]
628
+
629
+ Availability implications:
630
+
631
+ [AVAILABILITY_IMPACT]
632
+
633
+ Recovery requirements:
634
+
635
+ [RECOVERY_REQUIREMENTS]
636
+
637
+ Dependency failures:
638
+
639
+ [DEPENDENCY_FAILURES]
640
+
641
+ Fallback strategy:
642
+
643
+ [FALLBACK_STRATEGY]
644
+
645
+ Operational risks:
646
+
647
+ [OPERATIONAL_RISKS]
648
+
649
+ Design resilience proportionate to business requirements.
650
+
651
+ ## 20. Infrastructure and Cloud
652
+
653
+ Hosting approach:
654
+
655
+ [HOSTING_APPROACH]
656
+
657
+ Cloud provider:
658
+
659
+ [PROVIDER_OR_NONE]
660
+
661
+ Managed services:
662
+
663
+ [MANAGED_SERVICES]
664
+
665
+ Container requirements:
666
+
667
+ [CONTAINERS_OR_NONE]
668
+
669
+ Kubernetes requirements:
670
+
671
+ [KUBERNETES_OR_NONE]
672
+
673
+ Infrastructure-as-Code:
674
+
675
+ [IAC_APPROACH]
676
+
677
+ Deployment model:
678
+
679
+ [DEPLOYMENT_MODEL]
680
+
681
+ No cloud provider is mandatory.
682
+
683
+ Evaluate AWS, Azure, GCP and other alternatives according to actual requirements.
684
+
685
+ Do not introduce Kubernetes without sufficient operational justification.
686
+
687
+ Consult docs/architecture.md and docs/scalability.md.
688
+
689
+ ## 21. Vendor Independence
690
+
691
+ Vendor-specific dependencies:
692
+
693
+ [VENDOR_DEPENDENCIES]
694
+
695
+ Portability constraints:
696
+
697
+ [PORTABILITY_CONSTRAINTS]
698
+
699
+ Replacement strategy:
700
+
701
+ [REPLACEMENT_STRATEGY]
702
+
703
+ Data export considerations:
704
+
705
+ [DATA_EXPORT]
706
+
707
+ Estimated migration complexity:
708
+
709
+ [MIGRATION_COMPLEXITY]
710
+
711
+ Vendor neutrality is desirable when it provides meaningful value.
712
+
713
+ Do not build costly abstractions solely to achieve theoretical portability.
714
+
715
+ ## 22. Financial Evaluation
716
+
717
+ Estimated initial cost:
718
+
719
+ [INITIAL_COST_OR_UNKNOWN]
720
+
721
+ Estimated monthly cost:
722
+
723
+ [MONTHLY_COST_OR_UNKNOWN]
724
+
725
+ Estimated annual cost:
726
+
727
+ [ANNUAL_COST_OR_UNKNOWN]
728
+
729
+ Currency:
730
+
731
+ [CURRENCY]
732
+
733
+ Usage assumptions:
734
+
735
+ [USAGE_ASSUMPTIONS]
736
+
737
+ Pricing sources:
738
+
739
+ [PRICING_REFERENCES]
740
+
741
+ Pricing verification date:
742
+
743
+ [YYYY-MM-DD_OR_NOT_VERIFIED]
744
+
745
+ Possible cost growth:
746
+
747
+ [GROWTH_COST_SCENARIOS]
748
+
749
+ Cost controls:
750
+
751
+ [COST_CONTROLS]
752
+
753
+ Budget approval:
754
+
755
+ [APPROVAL_STATUS]
756
+
757
+ Never invent pricing.
758
+
759
+ Do not create paid commitments based on an ADR alone.
760
+
761
+ Consult docs/cost-engineering.md.
762
+
763
+ ## 23. AI and Agentic Systems Impact
764
+
765
+ Complete this section only if relevant.
766
+
767
+ AI functionality:
768
+
769
+ [AI_FUNCTIONALITY]
770
+
771
+ Model providers:
772
+
773
+ [MODEL_PROVIDERS]
774
+
775
+ Inference costs:
776
+
777
+ [INFERENCE_COSTS]
778
+
779
+ Agent responsibilities:
780
+
781
+ [AGENT_RESPONSIBILITIES]
782
+
783
+ Authorized tools:
784
+
785
+ [AUTHORIZED_TOOLS]
786
+
787
+ RAG architecture:
788
+
789
+ [RAG_ARCHITECTURE]
790
+
791
+ Evaluation requirements:
792
+
793
+ [EVALUATION_REQUIREMENTS]
794
+
795
+ Prompt injection controls:
796
+
797
+ [PROMPT_INJECTION_CONTROLS]
798
+
799
+ Human oversight:
800
+
801
+ [HUMAN_OVERSIGHT]
802
+
803
+ Data exposure risks:
804
+
805
+ [DATA_EXPOSURE_RISKS]
806
+
807
+ Do not use generative AI where deterministic methods are more appropriate.
808
+
809
+ Consult docs/ai-and-llm.md.
810
+
811
+ ## 24. Platform Compatibility
812
+
813
+ Applicable platforms:
814
+
815
+ [PLATFORMS]
816
+
817
+ Compatibility requirements:
818
+
819
+ [COMPATIBILITY_REQUIREMENTS]
820
+
821
+ Accessibility implications:
822
+
823
+ [ACCESSIBILITY]
824
+
825
+ Offline behavior:
826
+
827
+ [OFFLINE_BEHAVIOR]
828
+
829
+ Release constraints:
830
+
831
+ [RELEASE_CONSTRAINTS]
832
+
833
+ For relevant projects, consult:
834
+
835
+ - docs/mobile-and-web.md
836
+ - docs/platforms-and-applications.md
837
+
838
+ Do not impose requirements from unrelated platforms.
839
+
840
+ ## 25. Quality and Testing
841
+
842
+ Required unit tests:
843
+
844
+ [UNIT_TESTS]
845
+
846
+ Required integration tests:
847
+
848
+ [INTEGRATION_TESTS]
849
+
850
+ Required end-to-end tests:
851
+
852
+ [E2E_TESTS]
853
+
854
+ Security validation:
855
+
856
+ [SECURITY_TESTS]
857
+
858
+ Performance validation:
859
+
860
+ [PERFORMANCE_TESTS]
861
+
862
+ Build verification:
863
+
864
+ [BUILD_VALIDATION]
865
+
866
+ Acceptance criteria:
867
+
868
+ [ACCEPTANCE_CRITERIA]
869
+
870
+ Do not report tests as passed before executing them.
871
+
872
+ Consult docs/quality-and-testing.md.
873
+
874
+ ## 26. Observability and Operations
875
+
876
+ Required logs:
877
+
878
+ [LOGGING]
879
+
880
+ Metrics:
881
+
882
+ [METRICS]
883
+
884
+ Tracing:
885
+
886
+ [TRACING]
887
+
888
+ Alerts:
889
+
890
+ [ALERTS]
891
+
892
+ Operational dashboards:
893
+
894
+ [DASHBOARDS]
895
+
896
+ Incident response implications:
897
+
898
+ [INCIDENT_RESPONSE]
899
+
900
+ Data retention and privacy:
901
+
902
+ [TELEMETRY_PRIVACY]
903
+
904
+ Cost implications:
905
+
906
+ [OBSERVABILITY_COSTS]
907
+
908
+ Consult docs/observability.md.
909
+
910
+ ## 27. Migration Strategy
911
+
912
+ Complete when replacing or significantly changing an existing system.
913
+
914
+ Current state:
915
+
916
+ [CURRENT_STATE]
917
+
918
+ Target state:
919
+
920
+ [TARGET_STATE]
921
+
922
+ Migration approach:
923
+
924
+ [MIGRATION_APPROACH]
925
+
926
+ Compatibility strategy:
927
+
928
+ [COMPATIBILITY_STRATEGY]
929
+
930
+ Data migration requirements:
931
+
932
+ [DATA_MIGRATION]
933
+
934
+ User impact:
935
+
936
+ [USER_IMPACT]
937
+
938
+ Downtime risks:
939
+
940
+ [DOWNTIME_RISKS]
941
+
942
+ Rollback feasibility:
943
+
944
+ [ROLLBACK_FEASIBILITY]
945
+
946
+ Do not assume every migration is reversible.
947
+
948
+ ## 28. Implementation Plan
949
+
950
+ Implementation stages:
951
+
952
+ 1. [STAGE_1]
953
+ 2. [STAGE_2]
954
+ 3. [STAGE_3]
955
+ 4. [STAGE_4]
956
+
957
+ Dependencies:
958
+
959
+ [DEPENDENCIES]
960
+
961
+ Required resources:
962
+
963
+ [RESOURCES]
964
+
965
+ Expected deliverables:
966
+
967
+ [DELIVERABLES]
968
+
969
+ Validation milestones:
970
+
971
+ [VALIDATION_MILESTONES]
972
+
973
+ Keep implementation proportionate to project complexity.
974
+
975
+ ## 29. Operational Risks
976
+
977
+ Identify relevant risks.
978
+
979
+ Risk:
980
+
981
+ [RISK_DESCRIPTION]
982
+
983
+ Likelihood:
984
+
985
+ [LIKELIHOOD_OR_UNKNOWN]
986
+
987
+ Impact:
988
+
989
+ [IMPACT_OR_UNKNOWN]
990
+
991
+ Mitigation:
992
+
993
+ [MITIGATION]
994
+
995
+ Residual risk:
996
+
997
+ [RESIDUAL_RISK]
998
+
999
+ Owner:
1000
+
1001
+ [RISK_OWNER]
1002
+
1003
+ Repeat this structure for additional material risks.
1004
+
1005
+ Avoid speculative risk inflation.
1006
+
1007
+ ## 30. Reversibility and Rollback
1008
+
1009
+ Decision reversibility:
1010
+
1011
+ [REVERSIBLE | PARTIALLY_REVERSIBLE | DIFFICULT_TO_REVERSE | IRREVERSIBLE]
1012
+
1013
+ Rollback approach:
1014
+
1015
+ [ROLLBACK_PLAN]
1016
+
1017
+ Recovery prerequisites:
1018
+
1019
+ [RECOVERY_PREREQUISITES]
1020
+
1021
+ Data preservation requirements:
1022
+
1023
+ [DATA_PROTECTION]
1024
+
1025
+ Conditions requiring rollback:
1026
+
1027
+ [ROLLBACK_TRIGGERS]
1028
+
1029
+ Never claim reversible database changes without validating the recovery approach.
1030
+
1031
+ ## 31. Dependencies and Prerequisites
1032
+
1033
+ Required dependencies:
1034
+
1035
+ [DEPENDENCIES]
1036
+
1037
+ External accounts:
1038
+
1039
+ [EXTERNAL_ACCOUNTS]
1040
+
1041
+ Credentials:
1042
+
1043
+ [CREDENTIAL_REQUIREMENTS]
1044
+
1045
+ Infrastructure prerequisites:
1046
+
1047
+ [INFRASTRUCTURE_REQUIREMENTS]
1048
+
1049
+ Human actions:
1050
+
1051
+ [HUMAN_ACTIONS]
1052
+
1053
+ Missing prerequisites must be reported.
1054
+
1055
+ Do not invent credentials.
1056
+
1057
+ ## 32. Decision Authority
1058
+
1059
+ Operating mode:
1060
+
1061
+ [SUPERVISED | AUTONOMOUS_BUILD]
1062
+
1063
+ Decision risk classification:
1064
+
1065
+ [LOW | MODERATE | HIGH | CRITICAL]
1066
+
1067
+ Decision authorization:
1068
+
1069
+ [WITHIN_APPROVED_SCOPE | REQUIRES_HUMAN_APPROVAL | EXPLICITLY_APPROVED]
1070
+
1071
+ Authorized scope:
1072
+
1073
+ [AUTHORIZATION_SCOPE]
1074
+
1075
+ Approval reference:
1076
+
1077
+ [APPROVAL_REFERENCE_OR_NONE]
1078
+
1079
+ This ADR documents a technical decision.
1080
+
1081
+ It does not grant additional operational permissions.
1082
+
1083
+ ## 33. Supervised Mode Requirements
1084
+
1085
+ In Supervised Mode:
1086
+
1087
+ - Investigate the relevant architecture.
1088
+ - Identify reasonable alternatives.
1089
+ - Document material trade-offs.
1090
+ - Present recommendations.
1091
+ - Obtain approval before significant changes.
1092
+ - Implement only within the approved scope.
1093
+ - Report verification results.
1094
+
1095
+ Do not modify production systems during a read-only architecture review.
1096
+
1097
+ ## 34. Autonomous Build Mode Requirements
1098
+
1099
+ In Autonomous Build Mode:
1100
+
1101
+ - Apply all relevant Global Engineering Standards.
1102
+ - Make ordinary architectural decisions within the approved scope.
1103
+ - Document significant decisions.
1104
+ - Continue implementation without unnecessary approval requests.
1105
+ - Run appropriate tests.
1106
+ - Correct identified defects.
1107
+ - Respect technical execution limits.
1108
+ - Escalate protected or out-of-scope operations.
1109
+ - Include unresolved approvals in the final handoff.
1110
+
1111
+ An explicit request to build a complete application authorizes ordinary engineering decisions within its scope.
1112
+
1113
+ It does not automatically authorize destructive operations, production deployment, privileged access changes or paid commitments.
1114
+
1115
+ Consult docs/governance.md.
1116
+
1117
+ ## 35. Engineering Standards Preservation
1118
+
1119
+ Architecture decisions in both operating modes must consider all applicable standards:
1120
+
1121
+ - Security.
1122
+ - Privacy.
1123
+ - Data integrity.
1124
+ - Reliability.
1125
+ - Scalability.
1126
+ - Cost efficiency.
1127
+ - Quality.
1128
+ - Testing.
1129
+ - Observability.
1130
+ - Platform compatibility.
1131
+ - Maintainability.
1132
+
1133
+ Autonomous execution changes the approval workflow, not the required engineering quality.
1134
+
1135
+ Do not weaken fundamental safeguards to finish development faster.
1136
+
1137
+ ## 36. Approval Requirements
1138
+
1139
+ Require appropriate human approval for:
1140
+
1141
+ - Production modifications.
1142
+ - Destructive migrations.
1143
+ - Significant breaking changes outside authorized scope.
1144
+ - Privileged security changes.
1145
+ - Significant financial commitments.
1146
+ - Major production architecture migrations.
1147
+ - Unrelated repository modifications.
1148
+ - Other protected operations.
1149
+
1150
+ Do not interpret an accepted ADR as blanket permission to perform these actions.
1151
+
1152
+ Approval must cover the actual operation where required.
1153
+
1154
+ ## 37. Decision Acceptance
1155
+
1156
+ Decision status:
1157
+
1158
+ [PROPOSED | ACCEPTED | REJECTED | SUPERSEDED]
1159
+
1160
+ Accepted by:
1161
+
1162
+ [AUTHORIZED_PERSON_OR_ROLE_OR_NOT_REQUIRED]
1163
+
1164
+ Acceptance date:
1165
+
1166
+ [YYYY-MM-DD_OR_PENDING]
1167
+
1168
+ Acceptance evidence:
1169
+
1170
+ [APPROVAL_REFERENCE_OR_NONE]
1171
+
1172
+ Conditions:
1173
+
1174
+ [CONDITIONS]
1175
+
1176
+ For ordinary autonomous decisions, record that acceptance falls within the explicitly authorized development scope when applicable.
1177
+
1178
+ Never fabricate human approvals.
1179
+
1180
+ ## 38. Validation Criteria
1181
+
1182
+ The decision is considered successfully implemented when:
1183
+
1184
+ 1. [VALIDATION_CRITERION_1]
1185
+ 2. [VALIDATION_CRITERION_2]
1186
+ 3. [VALIDATION_CRITERION_3]
1187
+
1188
+ Required evidence:
1189
+
1190
+ [EVIDENCE]
1191
+
1192
+ Validation status:
1193
+
1194
+ [NOT_STARTED | IN_PROGRESS | VERIFIED | FAILED | BLOCKED]
1195
+
1196
+ Do not mark VERIFIED without relevant evidence.
1197
+
1198
+ ## 39. Outcome and Consequences
1199
+
1200
+ Expected positive consequences:
1201
+
1202
+ [POSITIVE_CONSEQUENCES]
1203
+
1204
+ Expected negative consequences:
1205
+
1206
+ [NEGATIVE_CONSEQUENCES]
1207
+
1208
+ Known trade-offs:
1209
+
1210
+ [TRADE_OFFS]
1211
+
1212
+ Remaining technical debt:
1213
+
1214
+ [TECHNICAL_DEBT]
1215
+
1216
+ Operational consequences:
1217
+
1218
+ [OPERATIONAL_CONSEQUENCES]
1219
+
1220
+ Document both benefits and limitations.
1221
+
1222
+ ## 40. Post-Implementation Review
1223
+
1224
+ Review date:
1225
+
1226
+ [YYYY-MM-DD_OR_NOT_SCHEDULED]
1227
+
1228
+ Observed results:
1229
+
1230
+ [MEASURED_RESULTS_OR_NOT_YET_AVAILABLE]
1231
+
1232
+ Unexpected consequences:
1233
+
1234
+ [UNEXPECTED_CONSEQUENCES]
1235
+
1236
+ Cost outcome:
1237
+
1238
+ [COST_OUTCOME_OR_UNKNOWN]
1239
+
1240
+ Performance outcome:
1241
+
1242
+ [PERFORMANCE_OUTCOME_OR_UNKNOWN]
1243
+
1244
+ Required follow-up:
1245
+
1246
+ [FOLLOW_UP]
1247
+
1248
+ Separate expected results from actual measurements.
1249
+
1250
+ ## 41. Supersession and Replacement
1251
+
1252
+ If a later decision replaces this ADR:
1253
+
1254
+ New ADR reference:
1255
+
1256
+ [REPLACEMENT_ADR]
1257
+
1258
+ Reason for replacement:
1259
+
1260
+ [REASON]
1261
+
1262
+ Supersession date:
1263
+
1264
+ [YYYY-MM-DD]
1265
+
1266
+ Migration implications:
1267
+
1268
+ [MIGRATION_IMPLICATIONS]
1269
+
1270
+ Preserve the original decision history.
1271
+
1272
+ Do not silently rewrite previous decisions to match new architecture.
1273
+
1274
+ ## 42. Decision History
1275
+
1276
+ | Date | Change | Responsible Party |
1277
+ |---|---|---|
1278
+ | [YYYY-MM-DD] | [INITIAL_DECISION] | [PERSON_OR_ROLE] |
1279
+
1280
+ Record meaningful updates.
1281
+
1282
+ Do not fabricate entries.
1283
+
1284
+ ## 43. Final ADR Principles
1285
+
1286
+ Base decisions on verified requirements.
1287
+ Evaluate relevant alternatives.
1288
+ Consider actual project constraints.
1289
+ Apply security by design.
1290
+ Apply privacy by design.
1291
+ Preserve data integrity.
1292
+ Plan for credible scalability.
1293
+ Avoid premature infrastructure complexity.
1294
+ Evaluate financial and operational costs.
1295
+ Prefer maintainable solutions.
1296
+ Protect production systems.
1297
+ Use evidence where available.
1298
+ Document important trade-offs.
1299
+ Preserve architecture decision history.
1300
+ Respect human approval boundaries.
1301
+ Support authorized autonomous development.
1302
+ Never fabricate verification or approval.