Skip to content

Living Documentation Framework

Matthew Hall edited this page Jul 18, 2018 · 5 revisions

Definition

Living Documentation as a term may be new to you, but when you understand what it is it will seem like something you have always wished for. When asked to prepare some documentation on a project have you ever thought to yourself,

"What is the point of this?"
"No one will ever look at this after we create it."
"This will be out of date as soon as we complete it."
"Great, another piece of shelfware."

It is natural for people to distance themselves from things that are dying. We wouldn't get on a sinking ship. We wouldn't accept a job offer for a company that had just declared bankruptcy. We all want to produce and create things that will be useful to people and make a difference to people in their day to day lives.

This Living Documentation Framework aims to show you how to restructure the documentation that is being produced and utilize automated tools for formatting and displaying that content to the users and team members who need it and value it. Below is the original image of the framework. But the Living version can be seen here:

Living Documentation Framework

Living Documentation Framework