“The first step towards getting somewhere is to decide that you are not going to stay where you are.” – Unknown

So as I mentioned in my previous article that how I got an opportunity to work in an open source project as working as a web developer trainee in StartUp. I was very excited and curious about the project. Open Source project is all about letting people know about your idea and how are you perceiving it. So in order to make them aware of what your project is all about, you should have a well-designed document to present to all the contributors and learners.

Getting Started: The first thing where the people will be putting their eyes on your open source project repository is README.md, not because of the appealing name but because it’s will be containing the heart and soul of your project. All the prerequisites, installation guide, what your project actually do and every single piece of information will be mentioned in the README.md file. So it’s necessary that you should put every information in that document.

My Experience: Documentation is not as easy as it looks, I mean it requires a lot of mental brainstorming. It might felt useless and waste of time and energy at first but when you start putting some genuine efforts, it all starts making sense. The process of documenting might look for others but it put more impact on the person who goes through the process. The documentation of the project gives you an opportunity to understand your project more briefly. 

Documentation helps in many ways.It enables you to set a correct vision of the things as they are, and not how you think they are. It is essential to set a correct perspective for others about your project and that can only be done with detailed documentation. 

So as I said it might look useless……..waste of time and energy but I assure you once you get into the habit of writing things like I have been doing with writing articles it will start making sense and also help you to grow.

If you have any additional ideas and feedbacks, please let me know in the comments.