Tag

Documentation

31 sheets with this mark.

  1. Flux residue you'll clean once and mean itNo-clean flux leaves a film; rosin demands solvent. Pick your cleanup strategy before the board goes in the box.
  2. Screw terminals that won't spin your wirePhoenix-style pluggables beat terminal blocks when you rewire in the field. Choose the right pitch and wire gauge before your prototype becomes permanent.
  3. Loop timing that matches your sensor's real bandwidthControl loops run at the speed your code permits, not the speed your sensor delivers. Measure what you're actually sampling before you tune gains that fight aliasing.
  4. Heatsink compound before the thermal runawayThermal interface material isn't optional when your regulator dissipates real watts. Apply it correctly or watch your voltage sag under load.
  5. Solder joint inspection before the power-on ritualVisual discipline catches cold joints and bridges while the iron is still warm. A methodical pass under good light saves hours of voltage-chasing later.
  6. Commit messages for hardware that won't lie in six monthsVersion control isn't just for code. When your schematic changes, write a message your future self will actually understand.
  7. Enclosure tolerances before the filing sessionYour project box sits on the desk looking sharp until you try to mount the board or close the lid. Learn to measure, budget, and document clearances so your next build closes on the first try.
  8. LDO headroom when your wall wart driftsLow-dropout regulators promise clean rails, but only if you leave them enough input voltage when your adapter sags under load. Here's how to spec the margin you actually need.
  9. Bill of materials that ships with the repoYour BoM is documentation that gets stale the moment you order parts. Store it alongside the schematic so both versions match when someone clones your work.
  10. PWM frequency you'll hear before your motor doesAudible whine from motor drivers isn't a feature. Push your PWM carrier above 20 kHz or accept the complaints.
  11. Bulk capacitor math that fits your drawerYou don't need a warehouse of every capacitor value. Three well-chosen bulk caps will cover most low-frequency ripple work if you know the trade-offs.
  12. Debounce switches in firmware, not hopeMechanical switches bounce. Your interrupt handler doesn't care about your optimism.
  13. Test points you'll probe without the regretBare pads on a prototype are archaeology by the second revision. Plan test access when the schematic is still warm.
  14. Strain relief that survives desk movesCable entry points fail when you skimp on strain relief. Here's how to spec and install it so connections last through repeated handling.
  15. Crimp terminals before the wire basketRework-free harnesses start with the right terminal, the right tool, and a pull test you won't skip.
  16. Solder mask clearance you'll measure onceThe gap between copper and mask determines whether your board survives assembly or becomes a bridging lesson. Here's how to spec it without the rework.
  17. Fasteners that belong in your enclosureThe screw you pick today decides whether you'll open that box again in six months. Choose hardware that respects future-you and the people who inherit your work.
  18. Encoder quadrature you'll decode without the phase chartIncremental encoders give you direction and distance, but only if you sample both channels correctly. Here's how to wire and poll quadrature without consulting the timing diagram every build.
  19. UART baud rates that match what you solderedCrystal tolerances and baud-rate math collide in real hardware. Here's how to pick speeds that won't drift into garbage frames.
  20. Panel cutouts that won't haunt your next buildDrilling holes in an enclosure shouldn't feel like a gamble. Here's how to mark, measure, and cut panel-mount components so they fit the first time.
  21. Pull-up resistors that won't lie to your microcontrollerWeak internal pull-ups work until they don't. Here's how to pick external resistors that keep your I²C lines honest and your GPIO reads predictable.
  22. ADC reference voltage you won't second-guessPick a stable voltage reference once and your analog reads stay honest. Here's how to choose one that survives your bench and your production run.
  23. Watchdog timers before the mystery rebootYour microcontroller will lock up eventually. A properly configured watchdog catches silent failures before they become field support calls.
  24. Wire strippers that won't nick your SaturdayCheap strippers leave nicks that fail months later. Here's how to choose tools that respect the conductor and your schedule.
  25. State machines that survive the prototypeFinite state machines aren't academic ceremony—they're how you keep firmware predictable when inputs misbehave and timers collide.
  26. Version your hardware like you mean itSilkscreen dates and commit hashes turn three identical boards into a timeline you can actually debug.
  27. Interrupt-driven sensor reads you'll debug oncePolling burns cycles and misses edges. Interrupt-driven sensor reads give you precision timing and lower power draw—if you set them up correctly the first time.
  28. PID tuning without the spreadsheet theaterStop guessing gains from blog posts. A disciplined step-response test and three coefficients you measure yourself will outperform any magic number you found online.
  29. Ground your boards before you ground yourselfStatic discharge kills components silently. A proper ESD workflow costs less than replacing one microcontroller and takes thirty seconds to build into habit.
  30. Sensor calibration you'll actually run twiceMost calibration routines gather dust in a comment block. Here's how to build the kind you'll invoke before every demo without groaning.
  31. The README is a jointIf the next person cannot reflow your project from the docs, the craft is incomplete.