Skip to content
Changes
                
Changes
                

Documentation Overview & Introduction

Reading time: 3 minutes

When strategy is conceived, it exists as pure intent, like an abstract vision of how things should be. When an operation is executed, it exists as pure action, the reality of what is.

Documentation is the bridge between strategy and operation. It is the process of translating intent into action, and action into understanding.

Whithout this bridge, an organization is just a collection of disconnected actions. The team does not understand the why, the what, or the how. There is no shared understanding, no alignment, and no progress. The result is chaos, confusion, and ultimately, failure.

Memory vs Record

Human memory is terrible at storing complex information. Memory degrades over time, is prone to bias, emotions and it is finite. When something relies on human memory, it is considered as a programmed structural amnesia.

That is why we have records. A record is a persistent, immutable representation of information. It is the opposite of memory.

We are all used to create or receive records in different formats.

Accounting has statements, quotes, invoices. Sales has orders, contracts, proposals. Marketing has campaign results. In IT we have PRDs, specs, tickets, postmortems, runbooks, code commits, etc. These documents exist for different reasons, but they all serve the same purpose: to provide a record of what happened, why it happened, and what should happen next.

Documentation transforms individual memory (what one person knows or thinks they know) into institutional record (what the organization possesses).

An undocumented system or process is a living thing. It grows, degrades, and dies with its creators. A documented system or process is an asset that remains, allowing the system to be analyzed, audited, and improved.

Collaboration as a shared reality

Collaboration is more than just people talking to each other. It is people operating within the same mental model. This mental model is called shared understanding.

When amateurs builds something, they build for themselves. Their interface is internal. When a professional builds something, they practice altruism. They write the document to create a shared reality for their peers, their successors, and their stakeholders. This is the social contract of professional work applicable in any domain.

So what is documentation?

Documentation is an umbrella term for everything in a lifecycle.

This is any written, visual or digital material that describes, explains or instructs something.

It serves as a record, provides proof or evidence for claims. It also offers guidance for users and accountability to stakeholders. In this topic we explore the main types of documents and why they matter.