Importance of proper documentation in a project

In the tech industry, it’s not uncommon for developers to work on project maintenance. You could be asked to fix a few bugs in a system which is already in production and has a user base. Or to add new features, or to refactor. Sometimes, you’d even be asked to rewrite the whole project in a different language/framework. For all these, it’s very important to setup the existing code on your development machine, and understand it properly. And for this, you need proper documentation. Most projects today have their own git repository. It’s very unlikely that a project is distributed within a team by copying it on to a storage device. Even your incomplete, two-year old pet projects are usually on GitHub. This means the projects have some sort of readme file. Well, they are not there for no re

Read More