DEV Community

Discussion on: The Importance of Writing Documentation in the Workplace

Collapse
 
steelwolf180 profile image
Max Ong Zong Bao • Edited

There's a saying for API development & DevOps. You should have a single source of truth that is easy to understand so that anyone can pick it up and run with it.

If your unable to have it written as a documentation that is easy to understand and in a accessible area. You are not able to scale yourself or organisation as a whole.

There will be times word of mouth is useful for codify ethos and stories so they will remember the lessons like "don't deploy on Friday", "deploy once a day", " leave no man behind" or "every marine is a rifleman"

Collapse
 
erikmelone profile image
Erik Melone

100% agree here. In an ideal world there would be some central location for documentation that can serve as the source of truth for the entire organization.

Unfortunately creating and maintaining that central place doesn't seem to be a practice that organizations follow. At my last role I started this central repository for documentation that I had hoped people would contribute to, but no one ever did. They always push it off for "later", but "later" never comes.