Live data from Hacker News

Ask HN: How do you document your hardware projects?

news.ycombinator.com

31–40 of 42 posts

Re: Ask HN: How do you document your hardware projects?

#31
post #20

Earlier quoted context omitted.

I think version control like this would work great with programmatic CAD like OpenSCAD

Since OpenSCAD uses basically source code format, it already does. I'm more interested in tracking and versioning edits to KiCAD schematics, for instance.

I think you are describing something similar to Perforce Versic [1]. I use this at work to diff schematic or layout. The ugly thing is: it's perforce.. I wish there was an open source alternative.

[1] https://www.perforce.com/products/versic

Re: Ask HN: How do you document your hardware projects?

#32
We're in hardware and health-tech, so we require an QMS system, but we're also a team of former software engineers, so we're starting off by using Git.

I did set things up in Notion, but software is already documented in Git, so now we add in our QAS documents for each pull request.

Re: Ask HN: How do you document your hardware projects?

#33
post #16

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…

A lifetime ago, I worked on a large project that was never completed because Google released Wave, which addressed the same problem. Wave did it in a less useful way, but my employer (understandably) didn't want to go toe-to-toe with Google and so abandoned it.

The main part I worked on was to be able to do exactly this (not for CAD files specifically, but including those). It was a very difficult, but rewarding, problem to solve.

Re: Ask HN: How do you document your hardware projects?

#34
post #16

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…

This is what allspice.io does

Re: Ask HN: How do you document your hardware projects?

#35
post #20

Earlier quoted context omitted.

I think version control like this would work great with programmatic CAD like OpenSCAD

Since OpenSCAD uses basically source code format, it already does. I'm more interested in tracking and versioning edits to KiCAD schematics, for instance.

KiCAD’s storage format is s-expressions, so it works OK with git (better than binary file formats). However I have not tried to merge concurrent edits by multiple people; I suspect if there is any conflict you are basically out of luck.

Re: Ask HN: How do you document your hardware projects?

#36
post #4
post #2

Obsidian or logseq. Saves as markdown and can be processed to other formats. Also allows writing as you work. For step by step stuff, I’d lean towards logseq as the UI but sharing a folder inside an obsidian vault folder. Logseq is more at the bullet level which can be more useful in certain cases Lots of videos on your tube on this setup to allow you to access the best plugins from both systems.

+1 for Logseq. I have tried so many note taking and organization apps. Logseq had a little bit of a learning curve, but it works better than anything else for my ADHD brain. With other apps, I would still spend so much time thinking about where to put my notes when it's already difficult for me to take notes and organize things in the first place. I would end up with what was essentially a digital junk drawer. It was…

When it works, it works. But just having a dozen pages for each project and maybe a few fixed pages (say "Currently reading") also work. Not sure what is better.

Re: Ask HN: How do you document your hardware projects?

#37
post #7

Mechanical Engineer here - this is the million dollar question. We currently use antiquated systems, or bad software based on antiquated systems. My approach - don’t rely on software. It’s a mentality, not a software. Your CAD should be organized in a future proof structure. Your analysis should reference the hardware by diagram. You should be able to easily find the analysis with nothing more than a hunch. Your draw…

Do you use a PDM system?

At work. I think it’s not very good most of the time.

Re: Ask HN: How do you document your hardware projects?

#38
post #3

Poorly, usually. Markdown files everywhere, occasionally a google doc if I'm away from the laptop. Usually hardware projects will end up in a git repo, but mostly for the benefit of whatever firmware I'm writing around it - if there's any specific Kicad integration with version control, I wouldn't know. The biggest changes I've made recently are leaving notes inside the schematic (so I can't miss them) and keeping lo…

Kicad stores as XML as you probably know and is fairly human readable, so I use git on the project folder directly. Works great, although manual merges are a little involved, but I'm never in that position.

Also a lot of notes in the schematics/layout as well, utilizing layers. Overall I'm pretty satisfied.

Re: Ask HN: How do you document your hardware projects?

#40
post #37

Earlier quoted context omitted.

Do you use a PDM system?

At work. I think it’s not very good most of the time.

It's all in the setup.

If done properly it can be setup to automate a lot of the tedious work, making the process of designing things much smoother.

If done improperly it adds even more nonsense to all the stuff you already are doing, so it makes the process If desiging things twice as hard and confusing.

The key - have people that have actually used it to design things architect the setup, not professional managers.

Post reply on HN