Documentation Approach : Enterprise Management

Well, I am a big fan of documentation and the reason for the same is not because I know a lot, the reason for the same is that I don't know a lot! Fact!

There are a lot of misconceptions that Agile Methodology is against Documentation.

Working software over comprehensive documentation

The above statement in Agile Manifesto states the importance of documentation in a project, but the real interception of the statement is often described incorrectly.

It means you should create documentation that provides value and at the same time does not hinder the team’s progress. Agile document requirements are user stories, which are sufficient for a software developer to begin the task of building a new function.

Major advanatages of documentations are:

  1. A single source of truth saves time and energy.
  2. Determine what others need to know about the product/services provided by us.
  3. The hiring and onboarding process can be easier.
  4. Enables Revision Control and provides a proper process for updates.
  5. Saves Time and Money - One of the most wanted and dreamed advantages of any process.
  6. Collaboration to the product/service increases.

So why is documentation often skipped or ignored?

Documentation is traditionally a time-consuming, skills-intensive, and often an unpopular task. These factors commonly result in the documentation either being skipped entirely or becoming the last task in a project schedule, loathed by the unfortunate developer or developers who are given the task.

Real-World Examples of this approach

  1. Gitlab
  2. Atlassian

A beautiful git repo for some tips and tricks : Beautiful Doc


Comments

Popular posts from this blog

Places to Visit In Kochi

Oracle University Learning Subscription

ELK : A Killer Solution for Log Analysis