5 Comments
User's avatar
Eric Mariasis's avatar

In my opinion, one of the biggest reasons that developers and software engineers hate to do documentation is that when you are in the workplace, completing documentation does not check off any metrics boxes for upper management and therefore your own job security if there is any. They usually care about features completed and direct problems solved. Often doing documentation is perceived to "take away" from feature development time.

Doojin Bek's avatar

There should be minimal features if you have a proper product designer in the company. A company should strive to keep a product minimal.

Luck Karki's avatar

i also hate the docs because it is really boring but i think we need to build a habit to start reading docs so i am reading minimum one two docs or blogs everyday now i thinks reading docs can make us a good learner

Cesar Franco's avatar

I used to hate them too but after seeing the impact, not only reading but most of all writing them, I completely changed my opinion and now I think its a main tool. Its simple, you can't fix soemthing you dont understand

Doojin Bek's avatar

If you don't have documentation for an API function, no one else will go out of their ways to read the codebase and discover it. Thus, if you don't write documentation, you just wrote beautiful technical debt.

A piece of code that no one else uses is technical debt.

Without documentation, even the most beautiful code is just technical debt or dead weight.

An airplane that has a lot of dead weight will not fly properly.