Guides¶
Long-form guides that go into depth on one subject. The Guidelines set the rules, the Standards set the technical requirements, and the Primers are short introductions. The guides explain how to do the work well.
Architecture and design¶
| Guide | Covers |
|---|---|
| C4 modelling for IoT and connected systems | The C4 levels applied to devices and cloud, diagrams as code, and a Structurizr DSL reference |
| Scaling the practice of architecture | The advice process and the alignment mechanisms that let autonomous teams make architecture decisions |
| Writing ADRs and RFCs | When to write each, and how to write them well |
| Writing a high-level design | Capacity estimation and the structure of a high-level design document |
| Writing a software design specification | A software design specification kept as docs as code |
| Running an architecture review board | What goes to the board, who sits on it, and how it decides |
Guides to architecture and design.
Connected devices¶
| Guide | Covers |
|---|---|
| IoT endpoint and edge gateway architecture | Device tiers, connectivity, power, edge storage and edge intelligence |
| IoT fleet operations, telemetry and digital twins | Onboarding, telemetry ingestion, digital twins, OTA campaigns and fleet observability |
| Cyber security and threat modelling for connected systems | Threat modelling, hardware security, transport security, secure updates and compliance |
| Hardware-in-the-loop and automated testing | The testing pyramid, host-based tests, virtual hardware, HIL benches and network chaos testing |
Guides to connected devices.
Engineering practice¶
| Guide | Covers |
|---|---|
| Git | How Git works, branching strategies and choosing a version control system |
| Reviewing code | How to read a change, give feedback and keep reviews useful |
| Agile requirements and user stories | User stories, acceptance criteria and how they trace to requirements |
| Defect management and debugging | Raising and classifying defects, systematic debugging and root cause analysis |
| Ways of working | Working agreements, onboarding, the development process, CI/CD, documentation and metrics |
Guides to engineering practice.
Deep dives¶
| Guide | Covers |
|---|---|
| Deep dives | Long explanations of CBOR, CoAP, LwM2M, NB-IoT, certificates and keys, RTOS internals, SysVars, MISRA C, static analysis, Git internals, and docs, diagrams and architecture as code |
The deep dives.