Missing documentation, a way for one developer to insult another developer
Setting up a "Hello World" project should never be a nightmare, but time and again I run into instances where a "Getting Started" project has a invisible "requirement", or steps which are not documented or they are assumed to be must know even before a "hello world" sample project.
My expectations for "Getting Started" is, it should contain entire step by step instructions. Strangely some developers while writing documentations, skip the requirement altogether and others link to documentation manual with no clear indication as to after landing on the fifty page document, one is suppose to read.
Why has it become a mandatory approach of developers, that because I suffered, others who follow in my foot steps should also suffer. It feels like as a web developer we are yet to evolve.
It was interesting to hear about the perspective from one of the colleague that, not having complete documentation is like insulting; from one developer to the other.
It's true, why should we make another developer suffer or use the brain power, on something that could have been written down. It's a net loss, for other developer to ask the owner of the sample or git project for for help. Then others researching and finding the solution to help out. If there is no financial benefit in hiding the information they why hold on to it?
If there is an action to be performed, then document it. Take a screenshot if necessary and make life easy of the fellow developer or new comer to the programming field.
Stop insulting each other, document the entire process.
Setting up a "Hello World" project should never be a nightmare, but time and again I run into instances where a "Getting Started" project has a invisible "requirement", or steps which are not documented or they are assumed to be must know even before a "hello world" sample project.
My expectations for "Getting Started" is, it should contain entire step by step instructions. Strangely some developers while writing documentations, skip the requirement altogether and others link to documentation manual with no clear indication as to after landing on the fifty page document, one is suppose to read.
Why has it become a mandatory approach of developers, that because I suffered, others who follow in my foot steps should also suffer. It feels like as a web developer we are yet to evolve.
It was interesting to hear about the perspective from one of the colleague that, not having complete documentation is like insulting; from one developer to the other.
It's true, why should we make another developer suffer or use the brain power, on something that could have been written down. It's a net loss, for other developer to ask the owner of the sample or git project for for help. Then others researching and finding the solution to help out. If there is no financial benefit in hiding the information they why hold on to it?
If there is an action to be performed, then document it. Take a screenshot if necessary and make life easy of the fellow developer or new comer to the programming field.
Stop insulting each other, document the entire process.
Comments
Post a Comment