FWIW, I spent a lot of my 40+ years working, trying to document well
enough so I could hand over a project to an operations team and then get
on with something new and more interesting.
I've been dabbling in OpenSCAD for 8 years, its not my first language,
Documentation is HARD.
Writing documentation for coding tools is much harder: if the problem
isn't broken into nibble sized chunks the job is impossible, books are
ten times harder than writing documentation under pressure when trying
to fix undocumented features.
I have found that in documentation for opensource systems it is hard to
find implementation detail at the right level if you are a novice, -
because the documentation is generally written by people who understand
the intricacies to the technology and write all the documentation from
their perspective, not for someone on a different or new learning curve,
[try reading the documentation for Home Assistant / ESPHome yaml and you
might see what I mean].
OpenSCAD is different, because it has:
- The Language Reference manual has examples, if I want more on
Boolean Algebra I go look somewhere else;
- There are numerous tutorials, the first five might not be for your
learning style, just like a book;
- Code is human readable [it might be a little impenetrable, drawing a
bevel gear in 3D is way beyond my mathematical abilities [probably];
- There's a book, maybe there's room for other books - just search
books on Excel or HTML, there are dozens;
- The discussion list [and the archives] are a great source of code
snippets, Marius, Revar and others do a great job supporting the
community, because that's what it is;
- So is Github and Printables and Thingiverse, there are other
excellent websites I've tripped over with tutorials and HowTo content;
- When the web was young and Google didn't exist, and AltaVista was as
good as it got, books were the only way;
- Now we have DuckDuckGo [and Google, and all the others], finding
solutions for OpenSCAD problems has never been easier;
Solving the ESPHome yaml problem was just a matter of asking the right
questions, in the right places
In a search engine.
I have just bought Marius' book from NoStarch, via Waterstones in the
UK, doesn't come with the PDF version though :-(, there are 8 OpenSCAD
books listed, interestingly, the other 7 are by authors I've never heard
of, including one called Python for 3D printing.
cheers,
BTW I am happy to assist with generating new documentation for the
community, once I figure out how to update the beta version on my
laptop, its a Flatpak :-(.
Roger.
FWIW, I spent a lot of my 40+ years working, trying to document well
enough so I could hand over a project to an operations team and then get
on with something new and more interesting.
I've been dabbling in OpenSCAD for 8 years, its not my first language,
Documentation is HARD.
Writing documentation for coding tools is much harder: if the problem
isn't broken into nibble sized chunks the job is impossible, books are
ten times harder than writing documentation under pressure when trying
to fix undocumented features.
I have found that in documentation for opensource systems it is hard to
find implementation detail at the right level if you are a novice, -
because the documentation is generally written by people who understand
the intricacies to the technology and write all the documentation from
their perspective, not for someone on a different or new learning curve,
[try reading the documentation for Home Assistant / ESPHome yaml and you
might see what I mean].
OpenSCAD is different, because it has:
* The Language Reference manual has examples, if I want more on
Boolean Algebra I go look somewhere else;
* There are numerous tutorials, the first five might not be for your
learning style, just like a book;
* Code is human readable [it might be a little impenetrable, drawing a
bevel gear in 3D is way beyond my mathematical abilities [probably];
* There's a book, maybe there's room for other books - just search
books on Excel or HTML, there are dozens;
* The discussion list [and the archives] are a great source of code
snippets, Marius, Revar and others do a great job supporting the
community, because that's what it is;
* So is Github and Printables and Thingiverse, there are other
excellent websites I've tripped over with tutorials and HowTo content;
* When the web was young and Google didn't exist, and AltaVista was as
good as it got, books were the only way;
* Now we have DuckDuckGo [and Google, and all the others], finding
solutions for OpenSCAD problems has never been easier;
Solving the ESPHome yaml problem was just a matter of asking the right
questions, in the right places
In a search engine.
I have just bought Marius' book from NoStarch, via Waterstones in the
UK, doesn't come with the PDF version though :-(, there are 8 OpenSCAD
books listed, interestingly, the other 7 are by authors I've never heard
of, including one called Python for 3D printing.
cheers,
BTW I am happy to assist with generating new documentation for the
community, once I figure out how to update the beta version on my
laptop, its a Flatpak :-(.
Roger.