i've seen people recommend novices in open-source to contribute documentation instead of code and this is really weird, because writing good documentation, to me, is much harder than writing good code in the time i wrote a medium complexity Yosys pass i documented like 2 cells
-
-
I see, this makes sense!
-
Right. Also, it’s important to note that the suggestion is to improve *user* documentation, not, like, comments or the project’s internal technical docs.
- Show replies
New conversation -
-
-
When I was working in devrel my favourite strategy for improving our docs, was to sit down with a novice and let them walk me through the docs, highlighting where the story didn’t make sense. It’s all too easy breeze over the “simple” parts when you know what you’re doing.
-
Yeah. I always find it interesting how many docs are essentially missing the first paragraph, where one should explain what the thing is in very broad terms, before diving into APIs and implementation details.
- Show replies
New conversation -
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.