How to Run a Documentation Audit

What a Documentation Audit Is For

A documentation audit is a systematic review of all existing documentation: what exists, what's accurate, what's outdated, what's missing, and what should be removed. It produces a clear picture of the current state of organizational knowledge and a prioritized action plan for improvement.

Teams run documentation audits for several reasons:

• The documentation is known to be outdated but it's unclear what specifically needs updating
• The organization is growing and existing documentation was built for a smaller team
• A major product, system, or process change has made a significant portion of documentation inaccurate
• Onboarding quality has declined and the cause is suspected to be documentation gaps
• There's a knowledge management initiative and the team needs a baseline to work from

An audit without a specific follow-up plan is a reporting exercise. The audit's value comes from the action it enables: knowing exactly what to update, create, remove, and maintain differently.

---

Step 1: Define the Audit Scope

A documentation audit can cover the entire organization's knowledge base or a specific domain. The scope determines how long the audit takes and how many people need to participate.

Scoping choices:

Full knowledge base audit: Covers all documentation. Takes 1-2 weeks for a 10-15 person team with 50-100 documentation pages. Produces the most complete picture; requires the most coordination.

Domain-specific audit: Covers documentation for one function, product area, or team. Takes 3-5 days. Useful when a specific area is known to have quality issues or when resources are limited.

New employee audit: Recent hires review documentation from their onboarding experience. Takes 1-2 hours per person. Produces the highest-signal feedback on documentation that directly affects onboarding quality.

Incident-triggered audit: After a significant incident where documentation gaps contributed, audit the documentation for the affected system or process. Takes 1-2 days. Targeted, high-urgency.

Define the scope before beginning. An undefined scope creates scope creep and makes completion uncertain.

---

Step 2: Create the Documentation Inventory

Before evaluating quality, inventory what exists.

The inventory spreadsheet:

Page title	URL/Location	Category	Owner	Last updated	Last reviewed
[Title]	[Link]	[Area]	[@name]	[YYYY-MM-DD]	[YYYY-MM-DD]

Create this inventory by:

• Exporting the page list from the wiki tool (Notion, Confluence, and Google Drive all support this)
• Manually adding pages from email, Slack pins, and other distributed locations
• Including any external documentation (vendor guides, regulatory requirements) that team members rely on

The inventory is the audit's working document. All evaluation information is added to it.

---

Step 3: The Four-Category Evaluation

For each item in the inventory, assign one of four categories:

Current (green): The content is accurate, well-organized, and serves its purpose. No action needed.

Needs update (yellow): The content is mostly accurate but has specific sections that are outdated, incorrect, or incomplete. Identify exactly what needs to change.

Needs rewrite (orange): The content is significantly outdated or poorly structured. Updating individual sections won't be sufficient — the article needs to be rewritten.

Archive or delete (red): The content describes a process, system, or policy that no longer exists; or the content is duplicated more accurately elsewhere; or the content serves no identifiable purpose. Candidates for archiving or deletion.

The evaluation criteria:

• Accuracy: Is the content correct based on current systems, processes, and policies? Ask: "If a new employee followed this documentation exactly, would they achieve the intended outcome?"
• Completeness: Does the content cover what users need to know? Are there significant gaps that would require them to look elsewhere?
• Findability: Can users find this content when they need it? Is it named appropriately? Is it in the right location?
• Currency: When was it last updated? Is the last-updated date visible?
• Ownership: Is there a named owner? Is that person still on the team in the relevant role?

---

Step 4: The Gap Analysis

The inventory evaluates what exists. The gap analysis identifies what should exist but doesn't.

Sources for gap analysis:

Support tickets and Q&A patterns: The questions that come up most often in support channels, Slack, or meetings that can't be answered with a link to existing documentation are documentation gaps.

New employee feedback: Recent hires can identify topics that were difficult to find or understand during onboarding. Their experience represents the real information needs that new employees have.

Team member survey: "What's the question you answer most often that isn't documented? What's the process you know from experience that isn't written down anywhere?" Asking this question across the team produces a list of tacit knowledge gaps.

External audit: A team member who is not deeply embedded in the area under audit reads the existing documentation with fresh eyes and identifies what's confusing, what's missing, and what's unclear.

The gap register:

Gap description	Source	Priority (H/M/L)	Assigned to	Due
[What's missing]	[Q&A / feedback / survey]	H	[@name]	[Date]

---

Step 5: Prioritization

Not all documentation issues have the same priority. Prioritize by:

Frequency of use: Documentation that's consulted daily or weekly is higher priority than documentation consulted annually.

Impact of inaccuracy: If following incorrect documentation leads to compliance violations, security incidents, or significant errors, it's a critical priority. If the impact is minor friction, it's lower priority.

Onboarding impact: Documentation gaps that affect new employee onboarding have outsized impact because they affect everyone who joins.

Ease of fix: A quick update to correct a single outdated fact is worth prioritizing over a complete rewrite that will take several days, all else being equal.

Priority matrix:

Priority	Criteria	Action
Critical	High frequency + high impact of inaccuracy	Fix immediately, within 1 week
High	High frequency or high impact	Fix in current quarter
Medium	Moderate frequency, moderate impact	Fix in next quarter
Low	Low frequency, low impact	Fix when time permits

---

Step 6: The Action Plan

The audit produces three outputs:

Update list: Pages that need specific changes, with the change described and an owner assigned.

Creation list: New documentation that needs to be written, prioritized by impact, with owners assigned.

Archive/delete list: Pages that should be archived or removed, with justification.

The action plan template:

DOCUMENTATION AUDIT ACTION PLAN

Audit completed: [Date]
Scope: [What was audited]
Pages reviewed: [Number]

SUMMARY
Current/accurate: [N] pages
Needs update: [N] pages
Needs rewrite: [N] pages  
Archive/delete: [N] pages
Gaps identified: [N] items

IMMEDIATE ACTIONS (Critical priority, complete within 1 week):
1. [Page] — [Action needed] — [@owner] — Due: [Date]
2. ...

Q1 ACTIONS (High priority, complete in current quarter):
...

Q2 ACTIONS (Medium priority, complete next quarter):
...

DEFER (Low priority, no deadline):
...

---

Common Patterns the Audit Will Find

The founding-era documentation problem: Documentation written when the company was small and has never been updated. It reflects processes that no longer exist, tools that have been replaced, and teams that have been reorganized. Often the highest-effort remediation because the content needs complete rewriting rather than updating.

The expert-only documentation problem: Documentation that assumes significant prior knowledge, written by an expert for other experts. It covers the what but not the why or the how for someone starting from zero.

The template without content problem: Structure with no substance. Categories created but never filled, sections with placeholder text, outlines without articles.

The duplicate documentation problem: The same information documented in multiple places with slightly different content. Users find the older or less accurate version. Resolution: choose one canonical location; redirect or delete the duplicates.

The orphaned documentation problem: Documentation that was linked from a page that no longer exists and is therefore unfindable. It exists in the system but no one can navigate to it.

The no-owner problem: Documentation without a named owner. When it becomes outdated, there's no one to notify. These pages drift from accuracy over time and erode trust.

---

Who Runs the Audit

A documentation audit requires different contributors at different stages:

The audit coordinator: One person who manages the inventory, coordinates the evaluation sessions, compiles the gap analysis, and writes the action plan. This person doesn't need to know the content deeply — they need to be organized and persistent.

Content owners: The people responsible for each documentation area participate in the evaluation of their area. They know which pages are accurate and which are outdated better than anyone else.

New employees: Recent hires participate in the gap analysis — their fresh perspective is the most reliable signal for onboarding documentation gaps.

A fresh eye: One person who is not embedded in the area under audit reads a sample of the documentation as a user would. Their confusion is the documentation's failure; their frustration is the findability problem made visible.

---

Running the Audit Efficiently

A documentation audit doesn't need to be a multi-week project. With the right preparation:

3-5 person team, 50 pages, 1 week:

Day 1: Create the inventory, assign categories, distribute evaluation assignments Day 2-3: Individual evaluation (each team member reviews their assigned pages) Day 4: Compile evaluations, run gap analysis session (30 minutes) Day 5: Write action plan, prioritize, assign owners

Evaluation efficiency:

Each page evaluation takes 10-20 minutes for a familiar topic, longer for unfamiliar ones. Team members evaluate only pages they're qualified to assess. The goal is honest, informed evaluation — not exhaustive review of every sentence.

---

After the Audit: Making the Action Plan Stick

The most common audit failure: the action plan is written, distributed, and then ignored. Three months later, nothing has changed.

What makes action plans stick:

• Deadlines are specific, not ranges ("by October 15" not "this quarter")
• Owners are individuals, not teams ("@name" not "@content-team")
• Progress is reviewed in a team meeting or 1:1 within 30 days
• Critical priority items have follow-up built in: "Check on this in 1 week"

The rolling review:

After the initial audit, a quarterly review process (much smaller scope — 30 minutes, review pages not updated since the last review) prevents the need for another full audit. The annual or bi-annual full audit updates the baseline; the quarterly review maintains it.

---

Worked Example: A Customer Success Team's First Audit

Setup: A 12-person customer success team with a Notion workspace. They've been using it for 2 years. No one knows exactly how many pages are in the workspace or when they were last updated.

Their audit:

Day 1: The team lead exports the Notion page list. They find 84 pages. She assigns each to one of 4 team members based on who would know the topic. She adds the inventory to a shared spreadsheet.

Days 2-3: Each team member evaluates their 20-21 pages. They mark each Current, Needs Update, Needs Rewrite, or Archive. They add one-line notes on what specifically is wrong for any non-green pages.

Day 4: The team lead compiles the results. Findings: 31 Current, 28 Needs Update, 12 Needs Rewrite, 13 Archive. She runs a 30-minute gap analysis session; the team identifies 15 missing topics from their recent support ticket themes.

Day 5: She writes the action plan. 5 Critical priority items (outdated onboarding docs and two pricing pages with wrong information). 11 High priority items. 15 new pages to create, prioritized by support ticket frequency.

Month 1: Critical items completed. 4 of 11 High priority items completed.

Month 3: 35 of 40 action plan items completed. New employee survey score for "documentation was helpful during onboarding" improves from 3.2/5 to 4.1/5. Team's support ticket volume from customers drops 18%.

---

Key Takeaways

1. The inventory is the foundation: knowing what exists before evaluating quality; exporting page lists from the wiki tool makes inventory creation efficient.
2. Four-category evaluation (Current, Needs Update, Needs Rewrite, Archive/Delete) produces actionable classifications: each category maps to a specific type of action, making the action plan straightforward.
3. Gap analysis sources (support tickets, new employee feedback, team survey) identify what should exist but doesn't: the audit evaluates what's there; the gap analysis finds what's missing.
4. Prioritization by frequency × impact prevents diffuse effort: critical items get immediate attention; low-priority items are tracked without blocking progress on high-value work.
5. The action plan fails without specific deadlines and named individual owners: "this quarter" and "@team" are not accountable; "October 15" and "@name" are.

---

Conclusion

A documentation audit produces two things: a clear picture of the current state and a prioritized action plan for improvement. The first thing is informational; the second is where the value lies. Teams that run audits and follow through on their action plans build knowledge bases that teams trust and use — the accumulating evidence of a maintained, reliable, findable information system. Teams that run audits without execution produce accurate assessments of a problem they haven't fixed. Run the audit; execute the action plan; schedule the quarterly review; repeat.

Try WebSnips free — save and annotate documentation audit resources, knowledge management frameworks, and team wiki best practices with your own context notes, tag by content status and team, and build the organized reference base that supports your documentation audit process from inventory to action plan.