Live data from Hacker News

Why programmers don’t write documentation

kislayverma.com

11–20 of 153 posts

Re: Why programmers don’t write documentation

#11
It's not that hard.

It just requires time, and I would be happy to spend that time (I love writing, whether docs or just thoughts). As long as there's no ticket for it (approved by a stakeholder and assigned to me by the micromanager), I can't clock hours on it, and if I'm not clocking hours on a ticket, I'll eventually get an angry call..

It's not just lack of incentives, it's disincentives.

Re: Why programmers don’t write documentation

#12
The problem with documentation is twofold: 1. it's broadcast-only. so you have to try to anticipate in advance what the questions might be. 2. it's disconnected from the source. so someone looking at the source code has no idea whether there is good, bad, or any documentation about it.

Re: Why programmers don’t write documentation

#13
post #8

> Writing is a tough, demanding task. It requires organizing our thoughts clearly, examining them critically, and expressing them clearly. While the expressing part can be simplified to some extent (depending on the quality of writing required), all three steps are taxing when done properly. Wow, almost sounds like some other aspect of a job a software engineer is required to do... > If a developer doesn’t write docu…

> > Not writing doesn’t block shipping (at least not right away).

> It should.

Perhaps, but it doesn't.

Re: Why programmers don’t write documentation

#14
It's not rewarded and recognized.

Good software, bad doc is probably okay.

Bad software, good doc is downright bad.

Therefore, people/exec/management don't prioritize it.

If it were to be compensated with 100k, you would get the best doc ever.

We can't improve things if we don't incentivize. We don't incentivize because it's not that important.

Re: Why programmers don’t write documentation

#15
post #8

> Writing is a tough, demanding task. It requires organizing our thoughts clearly, examining them critically, and expressing them clearly. While the expressing part can be simplified to some extent (depending on the quality of writing required), all three steps are taxing when done properly. Wow, almost sounds like some other aspect of a job a software engineer is required to do... > If a developer doesn’t write docu…

the last is bs. if you dont ship you wont make money, the compaby dies. if you dont write docs, you might incur tech debt but the company keeps on living. ofc if there is enough time and manpower: write docs, write unit tests, discuss architecture. no prob. but for a lot of companies speed is king

It's not bs. They said should, not must.

Yes there are trade offs with everything you do in IT, one of them is creating a shit place to work in the name of speed.

It might work for a little while but eventually you're going to realize you're shitting where you eat.

Re: Why programmers don’t write documentation

#19
post #15

Earlier quoted context omitted.

the last is bs. if you dont ship you wont make money, the compaby dies. if you dont write docs, you might incur tech debt but the company keeps on living. ofc if there is enough time and manpower: write docs, write unit tests, discuss architecture. no prob. but for a lot of companies speed is king

It's not bs. They said should, not must. Yes there are trade offs with everything you do in IT, one of them is creating a shit place to work in the name of speed. It might work for a little while but eventually you're going to realize you're shitting where you eat.

This was my attitude as well for much of my career, and it was a mistake. The "correct" decision depends on the state of the business and your resources at the time. And nothing else.
Post reply on HN