It’s not tough to see why. For most corporations, time is money, and they regularly find themselves climbing to release a product. It can therefore be attractive to save time by wounding corners-by shortening or removing development stages that seem to slow down the coding development.
Several programmers scoff at the meaning of this documentation. “I know what I’m doing!” they say. “Time is short, and writing about my effort will only slow things down. Also, if something goes wrong, I know that I can fix it.” This is a horribly nave and short-sighted method. Such a haughty attitude toward documentation can be terrible to a company’s future.
It doesn’t help that programmers and engineers are infamous for having dull communication skills. It doesn’t help that certification is a task that they rarely enjoy. The result is often an obstinate mess-utter software design chaos.
A nave programmer may think, such as, that in-code comments are not need. I know one engineer who laughed out loud when he saw me adding comments into my code. “Look at this man!” he laughed. “What a waste of time!” Definitely, few programmers would carry this outlook to such a risky; however, such viewpoints are still hidden to a great many software developers.
It’s not just in-code comments that are essential. In common, one should also document common software architectures, full designs, flows of logic, installation advices, and so forth. The careful requirements will obviously vary depending on one’s specific condition, but as a rule, these are useful benchmarks to struggle for. The action of writing these documents can be extremely helpful in guiding one’s design procedure, and it can provide useful tools for design analyses and peer response.
Unfortunately, many workers take the opposite view, and purposely save on the documentation. Often, they do this to confirm job security for themselves-and sometimes, this method works. By saving on documentation, however, he may wind up jeopardizing the corporation’s long-term success. Also, an astute company knows that a developer who documents well is worth far more than somebody who holds his cards close to his top. The latter may seem respected in the short term, but finally, he’s a long-term obligation.