Just thinking aloud. Change-tracking software like git works with "patches", that is, changes applied to a source file to produce the changed file. They are hardwired to work with text files like source code, with short lines, and with line-oriented changes. But nothing prevents such a system from working with arbitrary files, as long as there is a tool to create a "patch" or a "diff" (that is, a description of a cha…
I think version control like this would work great with programmatic CAD like OpenSCAD
Ask HN: How do you document your hardware projects?
21–30 of 42 posts
Re: Ask HN: How do you document your hardware projects?
#22I've tried many methods over the years, but in the end, the local Wiki serves my needs the best.
Re: Ask HN: How do you document your hardware projects?
#23Re: Ask HN: How do you document your hardware projects?
#24Just thinking aloud. Change-tracking software like git works with "patches", that is, changes applied to a source file to produce the changed file. They are hardwired to work with text files like source code, with short lines, and with line-oriented changes. But nothing prevents such a system from working with arbitrary files, as long as there is a tool to create a "patch" or a "diff" (that is, a description of a cha…
I think version control like this would work great with programmatic CAD like OpenSCAD
Re: Ask HN: How do you document your hardware projects?
#25I haven't found anything in the usual markdown, git, wiki suggestions that the tech crowd here gives that works as well. Inline images doesn't do this. Too bad because I really want a self hosted open source solution.
The best other option is a decent pdf editor because you can paste in and annotate and save without collapsing layers.
I am trying pdfxchanger viewer lately with the watermarks for free editing capabilities but might actually buy the license for the editor. This syncs via nextcloud or boox to my tablet but has limitations.
Re: Ask HN: How do you document your hardware projects?
#26Onenote has the advantage of a canvas and taking screenshots then annotating or drawing over these. Then you can edit resize canvas drag things etc as you re-edit. Mix than in with tables, flagging, check boxes and mobile device support just works and is great. I haven't found anything in the usual markdown, git, wiki suggestions that the tech crowd here gives that works as well. Inline images doesn't do this. Too ba…
Re: Ask HN: How do you document your hardware projects?
#27Onenote has the advantage of a canvas and taking screenshots then annotating or drawing over these. Then you can edit resize canvas drag things etc as you re-edit. Mix than in with tables, flagging, check boxes and mobile device support just works and is great. I haven't found anything in the usual markdown, git, wiki suggestions that the tech crowd here gives that works as well. Inline images doesn't do this. Too ba…
Re: Ask HN: How do you document your hardware projects?
#28/README.md defines problem, requirements, interfaces and any notes on structure and approach investigated or selected.
//v7/ alternatively /v7/x
This macro approach allows straightforward onboarding of new staff whilst effectively firewalling irrelevant/unauthorized information. This last bit is really helpful with a revolving door of engineers on a long and complex project. Use of git also allows leveraging third party dates to prove independent development in the unlikely case of IP litigation, and provides a clear design history for patent applications.
Within individual modules things like prototype images, videos, test results, any relevant supply chain information and so on are readily stored.
I tend to segregate PCBs and firmware from mechanical, so a conceptual hardware module may have one repo per board, one repo for overall mechanical design, and one repo for firmware. For the PCB repos, a lot of info is testing related, even right down to scope shots, PSU logs during bringup, state transitions, software test results, etc.
Efficacy: Current project (8 years) has dozens of modules, extreme complexity, 10,000 parts, evolving international supply chain. Using this approach, however, I have been able to manage things effectively.
Re: Ask HN: How do you document your hardware projects?
#29Re: Ask HN: How do you document your hardware projects?
#30Granted, these are "personal" (still revenue generating) projects and the bus factor is 1, but it works for me.