PDF or Web-Based Build Instructions

[joulupukki]

Right now we're using a PDF for the build instructions but we're curious which format you all prefer if you could choose.

 

[Aleph Null]

With a PDF, I have the option to print or view on a screen.

 

[joelorigo]

PDF for me. I make all kinds of notes throughout the whole process, from gathering parts that I have vs. what needs to be brought, color coding the types of capacitors, measurements of transistors and diodes, etc.

 

[derevaun]

I like to mark off parts with a highlighter, so I can face the agony of the couple components I need to order after all.

And, I print the build doc when I receive the board, in case the board/doc gets revised before I start on it. It's happened more time than I'd like to admit.

 

[Audandash]

I like the pdf. I download all build docs for every project I do in case I ever need to reference it at a later date. That also means I have the right version to reference even if a newer version replaces it. Just my 2 cents.

 

[Audandash]

That being said. I love the interactive Bom from KiCad as a supplement. It’s nice to have that up while I’m building.

 

[Erik S]

That being said. I love the interactive Bom from KiCad as a supplement. It’s nice to have that up while I’m building.

An interactive BOM is great for stuff requiring specialty parts. I've appreciated those from Madbean, C2CE, and some of the stacked PPCB stuff requiring low profile parts. Unfortunately doing that requires ongoing maintenance from the author to keep the links valid.

Even just having a separate summarized BOM/ parts ordering list is something I really appreciate. Having to go through and count up how many 1n caps and 100k resistors are in a project is a bummer.

 

[vigilante398]

Unfortunately doing that requires ongoing maintenance from the author to keep the links valid.

Or in my case, putting the links up once and just praying they stay valid so I don't have to touch them again.

 

[Erik S]

Or in my case, putting the links up once and just praying they stay valid so I don't have to touch them again.

I mean... It's supposed to be DIY.

You won't catch me complaining about a dead link here and there.

 

[GAStan]

I like a PDF for reasons mentioned. Maybe keep ALL revisions available.

In addition to the PDF it would be nice to have an Excel (compatible) BOM file, with or without links for individual parts. With links would be kind of a low maintenance Interactive BOM. Actually, if the BOM was posted as a forum thread members could revise/correct links and re-post it if they wanted.

 

[joulupukki]

Thanks for the great insights! We’ll keep using the PDF. I also just added a link to access previous versions (the whole website is hosted on GitHub): https://www.q-tune.com/build/

 

[Audandash]

An interactive BOM is great for stuff requiring specialty parts. I've appreciated those from Madbean, C2CE, and some of the stacked PPCB stuff requiring low profile parts. Unfortunately doing that requires ongoing maintenance from the author to keep the links valid.

Even just having a separate summarized BOM/ parts ordering list is something I really appreciate. Having to go through and count up how many 1n caps and 100k resistors are in a project is a bummer.

I like Roberts little cheat lists for this very reason.

 

[Robert]

Or in my case, putting the links up once and just praying they stay valid so I don't have to touch them again.

I have a clever solution to all this "build instruction" rigmarole .....

I like the idea of web based docs but it would have to be easily printable.

In practice a PDF seems to work better and just has an all around better feel to me personally. You also have to remember a lot of folks don't have computers at their workbench. (or computers, or workbenches)

 

[joulupukki]

I definitely like the control of how it prints using a PDF. You have full control over where the page breaks are, page numbering, etc. I guess I might be an odd one out where I avoid printing paper at all costs. I have an iPad that follows me everywhere, including the workbench.