4 ms·
tl;dr: Yes we try to document through READMEs, wikis etc. Documentation is hard. not because there aren't enough good tools. there are plenty actually. Problem
by codegeek 14y ago
tl;dr: Yes we try to document through READMEs, wikis etc.
Documentation is hard. not because there aren't enough good tools. there are plenty actually. Problem is: how to keep them updated with frequent changes in code, enhancements, business process changes etc. At very large companies with distributed teams across the globe (I work for these kind of companies), maintaining an updated documentation/readme is the challenge. Do you want to spend the time to update the doc. on every release, every ehnahcement, every production fix, short term/long term projects etc OR you want to deliver the product on tight deadlines. Now once a project is delivered, do you want to go back and updated READMEs ? Wait, I had a piece of code that I delivered in release x.y in New YOrk and wrote a nice README. A developer in London made some changes to it 6 months later but he never updated the documentation on that specific change or perhaps did not know where my README was or perhaps did not care enough. Now my README is outdated and pretty much useless. Very tough.
- taproot 14y agoIts not tough, you work with douchbags. I'm not trying to be rude here, I'm giving you some advice, change the habbits or leave, that kind of environment is toxic. "tight deadlines" when it takes 30 minutes to rewrite even a multiple page readme from scratch is a very poor excuse to not keep even the simplest form of documentation up to date. I know its much harder than that to just leave so I would suggest at the least: not accepting code changes from some out of town baddie who obviously doesn't respect you or your work. Trust me if your boss asks why you didn't merge and you say "he didn't spend 30 minutes to update the docs to reflect the changes" they will take your side, bosses care about future proofing and best practices being followed believe it or not.