SSEL Embedded Systems Standard
This document is meant to be a guideline for the acceptable programming and design of embedded systems for SSEL.
Ivey's 12 Rules
From Prof Mark Ivey in ECE:
- Golden Rule: Write your code like you would like someone to write code for you
- comments
- flow charts
- The two things that code must do is work and communicate.
- Double checking a connection takes a lot less time (=money) than replacing a damaged component
- Design for ESD - plan on ESD
- zap your partner not your part
- Keep RF out of your logic
- Account for unused pins
- Pull up/down resistors
- especially in CMOS
- Understand your test equipment
- Design first, build later, test in stages, document always
- If your microcontroller program doesn't work, there's a good reason
- If your brain hurts, give it a rest
- No spaghetti (code or wiring)
- Get a clear requirement specification, if it isn't clear make it clear. Understand the requirements
- Have fun
Proper documentation is essential for the future life of your project, if someone else can't understand it, it dies when you leave.