Engineering Standards – Overview » History » Version 1
Redmine Admin, 12/26/2025 05:14 PM
| 1 | 1 | Redmine Admin | h1. Engineering Standards – Overview |
|---|---|---|---|
| 2 | |||
| 3 | *Purpose:* Define the scope, intent, and governance of engineering standards at Tinggit |
||
| 4 | *Audience:* Engineering, Architecture, Security, QA, Product Leadership |
||
| 5 | |||
| 6 | {{toc}} |
||
| 7 | |||
| 8 | --- |
||
| 9 | |||
| 10 | h2. 1. Purpose of Engineering Standards |
||
| 11 | |||
| 12 | Engineering Standards exist to ensure that Tinggit builds software that is: |
||
| 13 | |||
| 14 | * Reliable |
||
| 15 | * Secure |
||
| 16 | * Maintainable |
||
| 17 | * Scalable |
||
| 18 | * Audit-ready |
||
| 19 | |||
| 20 | These standards define **how we build**, not **what we build**. |
||
| 21 | |||
| 22 | *bq.* Standards protect long-term quality, even when delivery pressure is high. |
||
| 23 | |||
| 24 | --- |
||
| 25 | |||
| 26 | h2. 2. Scope of This Section |
||
| 27 | |||
| 28 | The Engineering Standards section governs: |
||
| 29 | |||
| 30 | * Coding practices |
||
| 31 | * Architecture principles |
||
| 32 | * API and integration guidelines |
||
| 33 | * Security and compliance expectations |
||
| 34 | * Branching, PR, and review discipline |
||
| 35 | |||
| 36 | These standards apply to: |
||
| 37 | * All services |
||
| 38 | * All UIs |
||
| 39 | * All repositories |
||
| 40 | * All contributors |
||
| 41 | |||
| 42 | --- |
||
| 43 | |||
| 44 | h2. 3. What Belongs in Engineering Standards |
||
| 45 | |||
| 46 | Engineering Standards pages must contain: |
||
| 47 | |||
| 48 | * Long-lived rules |
||
| 49 | * “Must / Must Not” expectations |
||
| 50 | * Principles that survive multiple sprints |
||
| 51 | * Cross-team consistency requirements |
||
| 52 | |||
| 53 | Examples: |
||
| 54 | * Naming conventions |
||
| 55 | * Error-handling expectations |
||
| 56 | * Security baselines |
||
| 57 | * Architectural constraints |
||
| 58 | |||
| 59 | --- |
||
| 60 | |||
| 61 | h2. 4. What Does NOT Belong Here (Very Important) |
||
| 62 | |||
| 63 | The following must *never* be stored in Engineering Standards: |
||
| 64 | |||
| 65 | * Step-by-step tutorials |
||
| 66 | * Framework-specific how-to guides |
||
| 67 | * Temporary implementation decisions |
||
| 68 | * Sprint-specific design notes |
||
| 69 | * Experimental spike outcomes |
||
| 70 | |||
| 71 | Rules: |
||
| 72 | * If it changes sprint-to-sprint → it does not belong here |
||
| 73 | * If it is specific to one issue → it belongs in the issue |
||
| 74 | |||
| 75 | --- |
||
| 76 | |||
| 77 | h2. 5. Relationship to Other Wiki Sections |
||
| 78 | |||
| 79 | Engineering Standards are **orthogonal** to delivery processes. |
||
| 80 | |||
| 81 | |_. Area |_. Responsibility | |
||
| 82 | | Product Process | How work is planned and delivered | |
||
| 83 | | Sprint Rules | How execution is governed | |
||
| 84 | | Engineering Standards | How code is written and structured | |
||
| 85 | | Role Guides | How people apply standards and process | |
||
| 86 | |||
| 87 | Engineering Standards do NOT override: |
||
| 88 | * Product priorities |
||
| 89 | * Sprint commitments |
||
| 90 | * Release governance |
||
| 91 | |||
| 92 | --- |
||
| 93 | |||
| 94 | h2. 6. Current and Planned Standard Areas |
||
| 95 | |||
| 96 | The following standard areas may be added under this section: |
||
| 97 | |||
| 98 | * Coding Standards |
||
| 99 | * Architecture Principles |
||
| 100 | * API & Integration Guidelines |
||
| 101 | * Security & Compliance Practices |
||
| 102 | * Branching & PR Guidelines |
||
| 103 | |||
| 104 | Each area must: |
||
| 105 | * Have a clear owner |
||
| 106 | * Be reviewed periodically |
||
| 107 | * Avoid duplication with other sections |
||
| 108 | |||
| 109 | --- |
||
| 110 | |||
| 111 | h2. 7. Governance & Change Rules |
||
| 112 | |||
| 113 | To keep standards effective: |
||
| 114 | |||
| 115 | * Standards must be reviewed before addition |
||
| 116 | * Changes must be intentional and documented |
||
| 117 | * Breaking changes must be communicated |
||
| 118 | * Old standards must be deprecated, not deleted |
||
| 119 | |||
| 120 | If a standard changes: |
||
| 121 | * Create a new version or page |
||
| 122 | * Reference the old one |
||
| 123 | * Preserve history |
||
| 124 | |||
| 125 | --- |
||
| 126 | |||
| 127 | h2. 8. Enforcement Expectations |
||
| 128 | |||
| 129 | Engineering Standards are enforced through: |
||
| 130 | |||
| 131 | * Code reviews |
||
| 132 | * Automated checks (where applicable) |
||
| 133 | * QA validation |
||
| 134 | * Architecture review (when required) |
||
| 135 | |||
| 136 | Standards are not optional. |
||
| 137 | |||
| 138 | Exceptions must be: |
||
| 139 | * Explicit |
||
| 140 | * Documented |
||
| 141 | * Approved |
||
| 142 | |||
| 143 | --- |
||
| 144 | |||
| 145 | h2. 9. Final Statement |
||
| 146 | |||
| 147 | *bq.* Engineering Standards are not about control. |
||
| 148 | |||
| 149 | They are about enabling teams to move fast |
||
| 150 | *without breaking what they have already built*. |
||
| 151 | |||
| 152 | This page defines the boundaries. |
||
| 153 | Future standards must respect them. |