3 ms·
Improve your attitude. Seems like you're letting your incorrect assumptions hold you back. I had to write documentation for a DSL a couple of years ago. I stud
by yesenadam 5y ago
Improve your attitude. Seems like you're letting your incorrect assumptions hold you back.
I had to write documentation for a DSL a couple of years ago. I studied what made good documentation, what were considered the best docs, the different modes/parts of documentation etc. There are some very good talks on that. It was really fascinating. I realized how much I didn't know about it — doesn't sound like you reached that stage yet. Recognize that you are a total beginner, with everything to learn. Good luck!
e.g. I don't know anything better than The AWK Programming Language. It's great on so many levels - how it explains what AWK is and does (often omitted in github docs!), how it starts you off using it from page 1; how in <20 pages it's gotten you using all the main features; the friendly, helpful tone; the later chapters making advanced/useful tools/programs, etc etc. That and K&R C were my exemplars in great docs. Until I started learning about documentation-writing I didn't begin to appreciate just how good they are. Can't be an accident that bwk had a hand in both! https://archive.org/details/pdfy-MgN0H1joIoDVoIC7 https://archive.org/details/pdfy-MgN0H1joIoDVoIC7
- btschaegg 5y ago+1 on "The AWK Programming Language". I'm a big fan of the book (in fact, I just purchased a copy that is as old as I am from ebay, just to own it. I originally read the version on archive.org). To provide another example for documentation I found to be similarly well-written is the guide on dtrace.org [1]. [1]: https://dtrace.org/guide/preface.html https://dtrace.org/guide/preface.html