If someone’s having to read your docs, it’s not “simple”

Re:If someone’s having to read your docs, it’s not “simple” by EastSmith on Monday June 07, 2021 @09:37AM (#27422435)

I _do not read_ the docs. I read the readme in githib, if there is not enough information in it for my use case, I may continue searching.

Also, when I find a lib, I want to read some user stories, not 20 pages of documentation in yet another doc format. Simple user stories. If you need to do A, here are 3 lines. If you need to do B - here are 5 lines. If your lib lacks these user stories, I will probably skip it. Or if I really need it, I will use StackOverflow to find some use cases so I can relate to and get a better understanding of the lib.

_NOW_ I may read the docs after I have the user stories, so they better have some information how you can customize the 3 and 5 lines of code above.

[ Parent | on HN ]

Re:If someone’s having to read your docs, it’s not “simple” by pistoriusp on Wednesday June 09, 2021 @05:39AM (#27446017)

I think you're getting downvoted because none of what you mentioned isn't docs. You do read them, you just read a specific type of documentation.

[ Parent | on HN ]