Skip to content

// Documentation Culture

Write things down, make it a habit.

Most teams know they should document more. Few actually do it consistently. The problem is almost never laziness - it is that documentation sits outside the workflow instead of inside it. This guide covers why documentation fails, what lightweight processes actually work, and how to make writing things down as natural as writing code.

Why does documentation fail on most teams?

Documentation fails because it is treated as a separate activity from the work itself - something to do after the real work is done, when there is time, which there never is. The failure mode is predictable: a team decides to "improve documentation," creates a wiki, populates it during an enthusiastic first week, and then watches it decay as priorities shift and nobody maintains what was written. Six months later, the wiki is a liability - confidently wrong in places, missing in others, and universally distrusted.

The root causes are structural, not motivational. Understanding them is the first step toward building habits that stick.

Documentation is not part of "done"

On most teams, a feature is considered done when the code merges and the tests pass. Documentation - if it happens at all - is a follow-up task filed in the backlog, where it sinks to the bottom behind features with deadlines. The definition of done is the leverage point here: if updating docs is a required checkbox before a card can move to the Done column, it happens. If it is optional, it does not.

High friction for writing

When writing a document requires navigating to a separate tool, finding the right section, following a specific template, and submitting it for formal review, the activation energy is too high for the average developer on the average day. The result: only major features get documented, and the daily operational knowledge - the stuff that actually saves time - stays in people's heads.

No ownership, no maintenance

A document without an owner is a document that will rot. When nobody is explicitly responsible for a page's accuracy, nobody checks it. When nobody checks it, it drifts from reality. When it drifts from reality, people stop trusting it. When people stop trusting docs, they stop reading them - and the cycle of neglect accelerates.

Writing is not rewarded

In most engineering cultures, shipping code is visible and rewarded. Writing documentation is invisible. Nobody gets promoted for writing an excellent runbook. Nobody's performance review mentions the onboarding guide that saved the last three hires a week of confusion each. Until documentation is recognized as valuable work - in retrospectives, in peer feedback, in promotion criteria - it will always lose the priority contest against features.

How do you make documentation a habit instead of a chore?

Building a documentation culture requires changing incentives, reducing friction, and embedding documentation into the existing workflow rather than bolting it on as a separate process.

Embed documentation in the card workflow

The most effective technique is adding a documentation requirement directly to your task cards. In Flux, add a checklist item to your card template: "Relevant docs updated." The card cannot move to Done until this box is checked. This is not bureaucracy - it is the same principle as requiring tests before merge. If you would not ship untested code, do not ship undocumented changes.

The scope should match the change. A small bug fix might need no documentation update. A new API endpoint needs its reference added. An infrastructure change needs the deployment runbook updated. The developer writing the code is the person best positioned to judge what documentation, if any, needs updating - and they are the person with the most context, right at the moment when context is fresh.

Lower the bar for first drafts

Perfection is the enemy of documentation. A rough, informal document written in five minutes captures 80% of the value of a polished one. Separate creation from refinement: write the draft now, improve it later. Use labels on your documentation board - "draft" vs "reviewed" - so the team knows which documents have been validated and which are best-effort captures.

Practical formats that lower the bar:

  • A markdown file in the repo. Lowest possible friction - the developer is already in their editor, and the doc ships with the code it describes.
  • A comment on the card. When a Flux card contains a non-obvious decision or debugging insight, adding a comment captures the knowledge in context. It is not a formal document, but it is searchable and linked to the work.
  • A PR description that explains "why." Pull request descriptions that explain the reasoning behind changes are a form of documentation that lives in the version control system permanently.

Run focused documentation sprints

A documentation sprint is a time-boxed effort - typically two to three days - where the team focuses on closing documentation gaps. Create a Flux board with columns: Identified, Drafting, Review, Published. Brainstorm every piece of knowledge that should be written down but is not. Create a card for each one, assign owners, and work through the backlog.

Documentation sprints work best as a kickoff. They create the initial body of documentation that ongoing habits can maintain. Running one every quarter catches the gaps that accumulate between regular updates. Running one whenever a new team member joins channels their questions - which are the most honest assessment of your documentation gaps - into cards on the board.

Assign owners with review cadences

Every document in your knowledge base should have an owner - a person responsible for its accuracy. This is not about gatekeeping edits; anyone should be able to update any document. Ownership means accountability for review: when the quarterly review cycle comes, the owner reads the document and either confirms it is current or updates it.

Track ownership with cards on your Flux board. Each major document gets a card with an assigned owner and a recurring due date. When the due date hits, the owner reviews the document and moves the card through the Review flow. This makes documentation maintenance visible - you can see at a glance which documents are overdue for review.

What lightweight processes work for small teams?

Small teams - two to eight people - do not need elaborate documentation frameworks. They need three things: a place to write, a trigger to write, and a way to track what was written.

The "write the doc you wish existed" rule

Whenever you find yourself explaining something to a teammate for the second time, write it down. The first time is a conversation; the second time is a documentation gap. This simple heuristic catches the most valuable documentation opportunities - the knowledge that people actually need repeatedly.

Documentation as onboarding fuel

New hires are your best documentation auditors. Every question they ask that is not answered by existing docs reveals a gap. Create a standing practice: during the first two weeks, every new hire creates at least five documentation cards on the Flux board for knowledge they had to discover by asking rather than reading. Assign those cards back to the team members who answered the questions - they have the context to write the docs.

Incident-driven documentation

After every incident, ask: "Did a runbook exist for this? If so, was it accurate? If not, should one be created?" Add a documentation card to the incident follow-up items. Incidents are powerful documentation triggers because the pain of missing documentation is fresh and specific. The runbook written after a 3 AM outage is the most useful document your team will ever produce.

Monthly documentation review in retro

Add a five-minute documentation check to your monthly retrospective. Two questions: "What documentation saved us time this month?" and "What documentation gap cost us time this month?" The answers produce specific, prioritized cards for your documentation board. Over time, this habit ensures that documentation investment follows actual team needs rather than theoretical completeness.

How do you know if your documentation culture is working?

Documentation culture is working when new team members can answer most of their first-week questions by reading existing docs. It is working when the team's first instinct after making a change is to update the relevant documentation. It is working when the knowledge base is trusted - people read it and act on it rather than asking in Slack for the "real" answer.

Signal Healthy Unhealthy
New hire onboarding time Days Weeks
Repeat questions in Slack Rare (answered by links to docs) Frequent (same questions, no doc to point to)
Docs mentioned in PRs Regularly ("updated the deploy guide") Never
Incident response Runbook followed, then updated Ad-hoc, knowledge in one person's head
Knowledge base trust Team reads docs first Team asks people first, docs are afterthought

Quantitative metrics help too. Track the number of documentation cards completed per month on your Flux board. Track the staleness rate - what percentage of documents have been reviewed within their cadence. Track new hire time-to-productivity. These numbers give you a trendline that justifies continued investment in documentation.

For the broader system of managing knowledge beyond documentation habits, see the knowledge management guide. For a practical template to kick off your first documentation sprint, use the documentation sprint board template.

// FAQ
03 questions
01

How do you convince a team to write documentation?

+

You do not convince them - you make documentation a natural part of the workflow. Add a documentation checkbox to your definition of done so cards cannot move to the Done column without it. Run a documentation sprint to create momentum. Celebrate documentation wins in retrospectives. When writing docs is required to complete work rather than a separate optional task, adoption happens without persuasion.

02

How much documentation is enough?

+

Enough is when a new team member can answer 80% of their first-week questions by reading existing docs instead of asking someone. You do not need to document every function or every decision. Focus on the knowledge that is expensive to rediscover: architecture decisions, deployment procedures, onboarding steps, and anything that has caused confusion or incidents in the past.

03

What is the best format for team documentation?

+

The format that your team will actually use. Markdown files in the repo work well for teams that live in their editor. Notion or Confluence works for teams that prefer rich editing. The format matters less than consistency - pick one place, agree on basic structure, and make it searchable. A messy wiki that everyone contributes to beats a beautifully structured one that nobody maintains.

// Start writing things down

Track documentation work. Free to start.

Kanban boards for documentation sprints, review cadences, and knowledge workflows. No credit card.