Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
10Dev28994yYES!! I DON'T NEED A FUCKING PARAGRAPH-LONG DESCRIPTION OF HOW TO WRITE WHATEVER, I NEED A FUCKING EXAMPLE THAT I CAN APPLY!!!
-
I would call it a requirement for commercial stacks to make thorough examples. However, if it's open source and people claim it just works, then good luck improving docs yourself 😜
-
The paragraphs that make mostly sense to someone who already knows that thing are the worst.
Then you get the super refined example that is whittled down so much that there is no context and you're not sure when you'd use this .... -
@N00bPancakes yeah and like that one specific example you need in the future shows up on the fourth fuckin page of Google
-
Also a few "whys" you would use the thing in a specific way would be nice:
I just ran into a situation today.
Bunch of examples using a specific method.
Great I'll use that method.
Then late I see this other method used sometimes for the same thing in pretty much the same way ... but why?
Later I find out the first method actually fucking sucks in some situations that you won't know until you hit it, thus the second method was born ... I DON'T KNOW MAYBE MENTION THAT SOMEWHERE!?!!??! ... naw they don't. -
Examples are good, but sometimes I need to know the precise intricacies of something. If I'm on the official docs rather than stackoverflow, I probably want to know where the bodies are buried
-
@N00bPancakes "Yeah we really wanna help people understand our product, so we are going to create a bunch of examples with the least amount of comments possible"
-
qwwerty11434yNobody says to drop the documentation. It would just be nice to have it accompanied by more than one simple basic example.
Already encountered projects, where the docs were not bad, but to figure the exact "how do i use it" i had to dive into their source code. -
Documentation is there because you simple cannot write enough examples. However having more than 3 fucking examples for each topic should be the norm.
Related Rants
I feel like technologies should spend wayyyy more time on making examples rather than ridiculously verbose documentation.
rant
examples