Technical Documentation & BOM
An embedded increment is not done if only the author can wire it. This subject is producing the artefacts a teammate or assessor needs: a wiring diagram or pin map, a bill of materials, and short firmware notes (how to flash, which branch, which config). Pretty slides are optional; traceability from requirement to part is not.
Starting Points
- Firmware architecture
- Studio template for BOM / wiring (if provided) or a simple spreadsheet plus a schematic screenshot.
- ISO/IEC/IEEE 15289 — overview of information items in systems engineering (awareness).
Key Points
- You maintain a BOM with part identity, quantity, and a source or datasheet link.
- You publish a pin map or wiring diagram that matches the device on the bench.
- You write flash/build instructions a classmate can follow without asking you.
- You keep documentation in the repo and update it when the hardware changes.
- You can trace a key requirement to a part or firmware module in that documentation.