3 ms·
People hate to update docs so the majority of the time it's out of date even if it was the best ever at one time. I was never told this but reading a ball of un
by WheelsAtLarge 7y ago
People hate to update docs so the majority of the time it's out of date even if it was the best ever at one time. I was never told this but reading a ball of undocumented code is part of the job so don't ever expect documentation when you start a job, especially at a startup.
Here are a few things that would make life easier.
- reduce the code's complexity. Some old-time programmers want to show off their skills at the cost of simplicity. Ya, ya you're god's gift to programming but the real skill is to program in a way that's easy to understand. And also saving memory is not your primary goal anymore.
- easy to update
- Summary of the software's function
-Major sections of the code should be titled and explained as briefly as possible incode.
- Docs should be part of the code review. I had a software package that would fail if the code was updated and the comments had not or the other way around. It was easy to disable but at least it made you think.
- Buy in from the management on keeping docs up to date. Very hard, managers want results not docs
-Regular review of the docs. Again, hard to achieve
- Make sure you don't abuse the manager's trust. If you say you are updating docs, you better be doing that.