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
-
I always find documentation very difficult to write. I run out of words. It's a fucken nightmare.
-
donuts238488yin-line, method names or Word doc? For #2, I write documentation but it's more like a cheat sheet kind.
In the professional world, documentation is very useful.... just not the 50-page kind... unless it's an API reference that lists all the functions and sample usage (but that's also a cheat sheet).
There are 2 use cases for documentation:
1. I just came back from vacation, I don't remember the stuff I wrote before I left or how to use it.... but hey past me wrote a document that describes step-by-step how to use it! (and all the parameter values needed)
2. Answering (dumb) questions only once.
-Support/other person: hey! how do you do....
-Me: here's some documentation, go away and read it... -
donuts238488yYou can also think of it this way.
Your brain is like RAM, and it is Cleaned everyday, especially when you sleep.
Documentation is like a harddrive... It will always be there... Assuming u can find it and it's not corrupted
The right kind of documentation is actually a productivity hack: having the information you need it a refresher, right at your finger tip.
Actually my general rule of thumb is write things down, its like pressing CTRL+S
Related Rants
So both my and my friends documentation for this project got rejected. It wasn't much of a surprise as we both have the same teacher who is very very strict on documentation. We are discussing all the documentation stuffs when he drops this:
Going to Africa and giving all children water is easier than getting this fucking documentation approved.
I fucking lost it xD. Okay, a bit harsh maybe but at least you get the idea.
undefined
burn
damn
documentation