A Plea

Pleeeeaase Explain Your Code

The importance of commenting and documenting your software program

Photo by Annie Spratt from Unsplash

Why All the Hate

The Six Benefits of Documentation

1. Documentation quickly reminds the creator of what he did in the past.

2. Documentation allows anyone who takes over the code to learn faster.

3. Documentation tracks what has been done to the code (i.e. versioning).

4. Documentation helps those not as proficient at coding.

5. Documentation helps technical people translate the code to business value.

6. Documentation keeps a record of lessons learned.


Data Analyst. Screenwriter. Project Manager. Now, Resume Coach. A student of life and West Coast Swing. A promoter of self from within. www.sunbreakresumes.com

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store