Content Audit: Evaluating Existing Documentation

A content audit systematically evaluates existing documentation for accuracy, completeness, consistency, and performance. Learn how to conduct an audit, categorize findings, and prioritize improvements.

What You'll Learn

You will learn how to plan and execute a content audit, categorize each page by quality and action required, and create an actionable report that drives documentation improvements.

Why It Matters

Most documentation sites accumulate outdated, duplicate, and inconsistent pages over time. A content audit reveals problems and provides data to prioritize fixes.

Real-World Use

DodaTech runs quarterly content audits across 17,000+ tutorial pages. The audit identifies outdated code examples, broken links, low-performing pages, and gaps in topic coverage.

flowchart LR
  A[Content Audit] --> B[Inventory]
  A --> C[Evaluate]
  A --> D[Analyze]
  A --> E[Recommend]
  B --> F[List All Pages]
  B --> G[Metadata Check]
  C --> H[Accuracy]
  C --> I[Quality]
  C --> J[Performance]
  D --> K[Categorize]
  D --> L[Prioritize]
  E --> M[Action Plan]
  F:::current
  classDef current fill:#f90,color:#fff,stroke:#333,stroke-width:2px

Step 1: Create a Content Inventory

List every page in your documentation with metadata.

import os
import yaml
from datetime import datetime

def inventory_pages(content_dir):
    inventory = []
    for root, dirs, files in os.walk(content_dir):
        for f in files:
            if f.endswith('.md'):
                path = os.path.join(root, f)
                mod_time = os.path.getmtime(path)
                inventory.append({
                    'path': path,
                    'last_modified': datetime.fromtimestamp(mod_time),
                    'size': os.path.getsize(path)
                })
    return inventory

pages = inventory_pages('content/')
print(f"Total pages: {len(pages)}")

Expected output:

Total pages: 17357

Step 2: Evaluate Each Page

Score each page on accuracy, quality, and performance.

def evaluate_page(page):
    score = 0
    # Accuracy: check for outdated references
    if 'deprecated' in page['content'].lower():
        score -= 10
    # Quality: check for required sections
    if '## Common Mistakes' in page['content']:
        score += 5
    if '## Practice Questions' in page['content']:
        score += 5
    # Performance: check analytics
    if page['bounce_rate'] > 70:
        score -= 10
    return score

Step 3: Categorize Findings

def categorize_page(score):
    if score >= 80:
        return 'Keep'
    elif score >= 50:
        return 'Improve'
    elif score >= 20:
        return 'Merge'
    else:
        return 'Archive'

scores = [85, 42, 73, 15]
for s in scores:
    print(f"Score {s}: {categorize_page(s)}")

Expected output:

Score 85: Keep
Score 42: Improve
Score 73: Improve
Score 15: Archive

Step 4: Create an Action Plan

Prioritize fixes by impact and effort.

## Audit Action Plan

### High Priority (Fix this week)
- Fix broken links in API reference
- Update Python 2.7 examples to Python 3.x
- Remove deprecated pages with no traffic

### Medium Priority (Fix this month)
- Merge duplicate troubleshooting guides
- Add practice sections to 20 tutorial pages
- Improve meta descriptions for low-CTR pages

### Low Priority (Fix this quarter)
- Standardize heading levels across all pages
- Add missing alt text to images
- Update copyright year in footer

Content Audit Template

# audit-entry.yaml
page: /python/variables/
title: Python Variables Explained
last_reviewed: 2025-01-15
accuracy_score: 7/10
quality_score: 8/10
performance_score: 6/10
issues:
  - Code example uses Python 3.8 syntax, should update to 3.10+
  - Missing common mistakes section
recommended_action: Improve

Common Mistakes

1. Auditing Without a Clear Goal

An audit needs a specific goal, such as reducing outdated content or improving SEO. Without a goal, the audit produces data but no action.

2. Trying to Fix Everything at Once

Audits reveal many problems. Prioritize the most impactful fixes and create a phased plan rather than trying to fix everything simultaneously.

3. Ignoring User Data

A page that looks outdated but ranks well and gets traffic should be updated, not deleted. Use analytics to inform decisions.

4. Creating an Audit with No Owner

Assign someone to own the audit Process and action items. Without ownership, recommendations are never implemented.

5. Not Scheduling Follow-Up Audits

A content audit is not a one-time event. Schedule regular audits to keep content fresh.

Practice Questions

1. What are the four categories for content audit findings?

Keep, Improve, Merge, and Archive.

2. Why should you check analytics during an audit?

Analytics reveal which pages are performing well, which have high bounce rates, and which have no traffic at all.

3. What is the difference between Improve and Merge?

Improve means the page has good content that needs updates. Merge means the page overlaps with another and should be combined.

4. How often should content audits occur?

Every 3-6 months for most documentation sites. Large sites may need quarterly audits.

5. Challenge: Audit five pages from a documentation site of your choice. Categorize each as Keep, Improve, Merge, or Archive with justification.

FAQ

Mini Project

Conduct a mini content audit of 10 pages from the DodaTech tutorials site or a documentation site of your choice. Create an inventory, evaluate each page, categorize findings, and write an action plan.

What's Next

After the audit, learn Content Gap Analysis to find missing content. Then study Content Plan creation.