ABC of Electronics cosycom.com
EMBEDDED SYSTEMS & MICROCONTROLLERS · PAGE 92

Documenting Firmware

Notes for the future you.

Keep a short readme with the board, pins used, tools and how to build and flash. Describe each module's purpose and its limits.

Add a pin table and a memory budget. Comments explain reasons and assumptions, and a change log lists what altered between versions.