Documenting projects

Well, it’s been some time since the last post. I’ve been busy moving to the other side of the country, to study mechatronics. Therefore I have not been able to do much hobby related things.

Anyways, recently I have been thinking of how I personally document the electronics work that I do, as well as how others do it. I have to admit, I’m not very good at it, usually I just get to it, ordering parts, soldering, coding, assembling etc. Often without any schematics, GitHub repository or other kinds of planning/documenting methods. I would really like to get better at this though,¬†because it would really help me in the long run, when I want to work on old projects, or like now, when I have had a break,¬† and want to continue my current projects. I figured I should write a list of things that can help with documenting electronics¬†projects. Like a reminder list.

  1. Use GitHub when coding!
  2. Learn to draw schematics and actually draw them, even for smaller projects. I have been using EasyEDA.
  3. Write logs, especially if it’s a bigger project, because it helps you remember what you did last time you worked on the project.
  4. Keep all components in a box. I often define a “project box”, which I label.

Leave a Reply

Your email address will not be published. Required fields are marked *