Best Practices To Include In Your Final Projects


Making that final push to button up your projects can be a bit daunting. It’s kind of like the punch list on a construction project — add switch plates, fill nail holes in baseboards, screw in light bulbs, clean windows — that stuff adds up quickly. But having a set of best practices in mind throughout the development phase will cut down on that burden. [Caleb P.] just published a quick guide using a recent project as an example.

First and foremost is the label seen on the project box lid. How many times have you pulled out a circuit board from a year or two earlier and not been able to figure out the pinout? As with ancient televisions and radios, including the service schematic will save you big time! He also mentions that the size and orientation of the components in the case was in the back of his mind the whole time. That paid off because everything fits like a glove. [Caleb] makes sure the battery is easy to get to, and the each component has some type of connector so that it may be removed and serviced/replace without soldering. There’s certainly nothing groundbreaking in this guide. But ask yourself: have I been following all of these guidelines in my own work?

41 thoughts on “Best Practices To Include In Your Final Projects

    1. No. This is not like 9001. 9001 is for management practices and has nothing to do with production. Furthermore ISO9001 is a plague, it acts like a virus where it is possible to lose your certification if you do business with non 9001 companies. Having taken part in an internal audit and being a guide during the cert process, buying the certifier a few beers and not ruffling about the $$$$$ price is the only thing that makes or breaks your cert any given year.

      All ISO9001 has managed to do is justify it’s own existence, make the PHB very proud and ruin many small b2b businesses that cannot afford the cert.

  1. Talking about plagues and bad practices, hot glue really should not be used in final versions for anything but filler, it has a nasty tendency to lose grip and fall off. Unless you want to remove it in which case it never comes off.

    It doesn’t handle UV well either so never use it anywhere that will be hit by sunlight.

    1. From what I understand there are various mixtures for hot glue used, so they would have various properties. The problem though is that it’s very rare to know what you are dealing with – unless you are some big conglomerate I guess.
      And then there are surfaces that don’t adhere to hot glue in any circumstance, sigh.

      1. Of course, there is even heat activated glue used in glue guns that then set and won’t melt again.

        I was talking about the general hot glue you get when you buy “glue sticks”. I have never come across one that actually works for anything but filling or temporary fastening.

  2. On a recent project I did for an organization I just stuck a USB drive inside the case with schematics, code, datasheets and the entire development environment. An 8GB drive costs less than $4 and makes the job a whole lot easier for the next person who needs to repair or mod the device.

  3. Each component has it’s own connector. Sounds like trouble in the future. Nothing like hard soldered. Molex schmolex, peterson pain. Mother board, daughter dropouts. I clip these things off and solder direct in so many repairs. Make the wires tough and long enough. Never use single strand wire outside of test strips, flex 3 times it breaks.
    Hot glue=temporally liquid duct tape.

  4. Wow. If that’s a neatly finished end product, then I’d hate to see what he does if he’s in a bit of a hurry.

    Not a bad idea to include a schematic inside – although maybe also add a link to something like a dropbox folder where you can find more details.

    1. I was in a hurry! This was something needed the day before I was asked to do it. But this is also a cheep and garage friendly way of building it. No custom printed boards, no crazy parts or connectors just good old hacker friendly parts, hot glue and solder.

      Dropbox links don’t last. In fact most things on the internet don’t stand the test of time. A physical piece should be included. I like the idea above of using a jump drive or micro SD card.

      1. Yes internet things do not last, But you could always use the law that gives you a right to view information about yourself to access the NSA copies :) That should add another 100 years of backups to your options.

        1. Come to think of it, if they make those NSA stores accessible by the ‘target’ it might actually become a thing that’s accepted and a big hit, like facebook is. Free unlimited storage of your life.

  5. Good points:
    Best practices – * documentation! Especially attached to the devices in some way so as to be permanent. Someone mentioned an SD card. Also a good idea. Personally, both sounds great; printed schematic and more details on the card.
    * Button it up good and tight. Hot glue, while less than ideal, is far better than just leaving things hanging.
    Not sure I agree on: Everything on the nasty side of the relay. For the specs stated on the cover, banana jacks are not really wise. Although, it largely depends on the intended application, which we know not. But if this is switching 110-220 AC at up to 7 amps, there should be some other form of connector there, or appropriate pig-tailed power cords. If it is just a general purpose low current DC switch, yeah ok Bananas are fine.
    Again, it depends on the actual duty of the device, but using header pins on the relay board outlets is clever but questionable. Sure, it solves a problem. But it is not ideal. And, given the love of hot glue, why not a mass of it on the spade pins on the female end of the headers?!?! If you have high current/AC passing through there, you most certainly would want to insulate that of all places.

      1. I’ve done one project where I wanted to have terminals. I cut 1/4 inch wide strips of thin brass, and soldered them on directly. could do a thin coat of solder if you preffer the silver color of a tin coating.

    1. ‘milspec’ is when you use a 35A 2kV 500MHz connector and cable for an LED and a button because someone decided that’s the minimum requirements for your application. There is thorough, then there is overkill, then there is milspec…

Leave a Reply

Please be kind and respectful to help make the comments section excellent. (Comment Policy)

This site uses Akismet to reduce spam. Learn how your comment data is processed.