Documentation Home Output Format

Output Format

Report structure, finding format, and CSV export specification for SEO CodeBase Auditor.

Files Generated

FilePurpose
seo_audit_report.mdFull audit report with executive summary, fix matrix, and per-pillar findings
seo_audit_report.csvSpreadsheet-ready Priority Fix Matrix

Report Structure (seo_audit_report.md)

# STRATEGIC SEO AUDIT REPORT
**Generated by:** [Team Name — URL]
**Generated on:** [Date]
**Audit Scope:** Local Repository Codebase

## Project Overview
[Site type, page count, primary target keywords, target audience, target geography]

## Executive Summary
[3-sentence assessment: How bad is it? What's the single most important action?]

## Priority Fix Matrix
[Table — top 20 issues sorted by severity and impact]

## Quick Wins
[Items implementable in <30 minutes]

## Medium-Term Improvements
[1-4 week sprint items]

## Long-Term Strategic Initiatives
[1-3 month foundational work]

## Revenue Impact Opportunities
[Fixes affecting conversion paths]

## Traffic Growth Opportunities
[Fixes affecting organic visibility]

## Granular Pillar Evaluations
### [Pillar Name]
- Files Audited
- Passed Checks
- Issues Found (Evidence / Impact / Fix format)

## CSV Export Reference
[Note about companion CSV]

## Recommended Technical Implementation
[Numbered implementation steps]

## Resources & References
[Linked reference documentation]

Mandatory Finding Format

Every finding must follow the Evidence / Impact / Fix three-part structure:

1. Evidence

Cite the specific file, line number, and code snippet that proves the issue exists.

- **Location:** `index.html:12`
- **Problem:** Title tag is missing entirely — the `<head>` section contains no `<title>` element.
- **Current Code:**
  ```html
  <head>
    <meta charset="utf-8">
    <!-- No <title> tag present -->
  </head>
  ```

2. Impact

State the ranking, traffic, or user-experience consequence. Quantify where possible.

- **Ranking Impact:** Pages without a title tag lose ~35-40% of organic CTR based on Backlinko/Moz CTR studies.
- **Root Cause:** The HTML file was created without a `<title>` element in the `<head>` section.

3. Fix

Provide the exact production-ready code replacement.

- **Fix:**
  ```html
  <head>
    <meta charset="utf-8">
    <title>SEO CodeBase Auditor — AI-Powered SEO Audit Tool | F9XR</title>
  </head>
  ```
- **Implementation Guidance:** Open `index.html`, locate the `<head>` tag, add the `<title>` element as the first child.
- **Fix Type:** metadata
- **Verification:** Re-run audit; confirm title tag appears in Priority Fix Matrix as resolved.

Priority Fix Matrix Format

#PillarDetected IssueSeverityTarget File(s)EffortEst. Traffic ImpactEst. Revenue ImpactTime to ImpactBusiness Value
1On-PageMissing unique H1 tagHigh/about.htmlS (<4hr)+5-10% organicMediumImmediateTraffic
2Perf.Images missing dimensionsHigh/index.html:45M (1-3d)+3-8% organicLow1-4 weeksTraffic

Severity Definitions

SeverityDefinition
CriticalDirectly blocks indexation, causes ranking penalty, or breaks core functionality
HighSignificantly weakens ranking potential or user experience
MediumSuboptimal but not immediately penalizing
LowBest-practice improvements with marginal direct impact

Effort Scale

LabelTimeframe
S<4 hours
M1-3 days
L1-2 weeks
XL2+ weeks

Business Value Categories

CSV Export Format

#  ,Pillar       ,Issue                     ,Severity ,File(s)                      ,Effort     ,Traffic Impact     ,Revenue Impact ,Time to Impact ,Business Value
1  ,On-Page      ,Missing unique H1 tag     ,High     ,/about.html                  ,S (<4hr)   ,+5-10% organic     ,Medium         ,Immediate      ,Traffic
2  ,Performance  ,Images missing dimensions ,High     ,"/index.html:45, /gallery.html:12" ,M (1-3d) ,+3-8% organic     ,Low            ,1-4 weeks      ,Traffic
3  ,Technical    ,Missing canonical tag     ,Critical ,/index.html                  ,S (<4hr)   ,Prevents indexation ,High           ,Immediate      ,Risk

Report Writing Rules

  1. Never write vague findings. "SEO could be improved" is not a finding. "The <title> tag on /about.html is 12 characters" is a finding.
  2. Write findings that survive peer review. Another SEO professional should agree with severity, evidence, and fix.
  3. Include the "so what?" for every finding. Why does this matter to the business?
  4. File-level specificity. Never say "some pages." List every affected file path.
  5. Show before/after for every fix. Current Code block → Fix block.
  6. Group related findings. Three pages with the same issue = one finding with three locations.
  7. Use active voice for fixes. "Add <meta name="viewport"> to index.html:5" — not "The viewport tag should be considered."
  8. Link to Google resources. Every Google Search Central, schema.org, or W3C reference should be clickable.
  9. End with the user's next action. The final line should be a command, not a summary.

Report Customization