Markdown Editor

Documentation Content Audit Template (Inventory, ROT)

Docs content audit: criteria, page inventory with owner, last verified, signals, accuracy, ROT verdict and action, findings, gaps, remediation, redirects

ドキュメント・サポートフルISO/IEC/IEEE 26511:2018 and 26513:2017 (structure); WCAG 2.2contentaudit

使い方: Use it before a docs platform migration, an IA redesign or as an annual review. Fill the criteria and verdict rules first, build the inventory from the repository and site map, then recompute the findings summary from the rows. The main pitfall is letting traffic alone decide a verdict or using signals that track individual readers.

プレビュー

Content Audit: [Documentation set or site name]

Quality audit and content inventory for a documentation set: scope and objectives, method and criteria, one inventory row per page (URL, Diátaxis type, owner, last verified date, usage and feedback signals, accuracy rating, ROT verdict and action), the verdict rules, a findings summary with recomputed numbers, gaps, a remediation backlog, the redirect and archive plan, and governance for the next audit. Structure aligned with the management and quality-evaluation activities of ISO/IEC/IEEE 26511:2018 (requirements for managers of information for users) and the review concepts of ISO/IEC/IEEE 26513:2017; accessibility signals refer to WCAG 2.2 (W3C Recommendation, 12 December 2024). Replace every [bracketed] value and every row marked Example.

Document control

FieldValue
Document ID[CAU-001]
Documentation set[Product name] [Docs site, section or repository]
Snapshot date (inventory taken)YYYY-MM-DD
Pages in scope[Number]
Product version documented[Version or versions]
Audit lead[@audit-lead]
Version[0.1]
Status[Planned / In progress / Findings issued / Remediation in progress / Closed]
Owner[@docs-owner]
Approvers/reviewers[@docs-lead], [@product-owner], [@support-lead]
Classification[Internal]
Last updatedYYYY-MM-DD
Next audit dueYYYY-MM-DD

Approvals

RoleNameDecisionDate
Docs owner[@name][Approve / Approve with conditions / Reject]YYYY-MM-DD
Product owner[@name][Decision]YYYY-MM-DD
Support lead[@name][Decision]YYYY-MM-DD

Revision history

VersionDateAuthorChange summary
0.1YYYY-MM-DD[@name]Scope and method agreed
0.2YYYY-MM-DD[@name]Example: Inventory complete, 10 pages assessed
1.0YYYY-MM-DD[@name]Example: Findings and remediation backlog approved

Contents

1. Scope and objectives

ItemValue
Audit trigger[Platform migration / IA redesign / Annual review / Support escalation trend]
Decisions this audit informs[For example: which pages move to the new platform; writer priorities for next two quarters]
In scope[Sections, versions, languages]
Out of scope[For example: translated pages (audited separately), marketing pages, API reference generated from the description]
Audit type[Full inventory / Sample of [N] pages chosen by risk / Qualitative deep dive on one section]
Accuracy check depth[Spot check by SME / Full task test of every procedure]

Example: Corvid Commerce audits its developer documentation before moving it to a docs-as-code platform. The audit decides which pages migrate, which merge and which are archived. Scope: English pages under /docs/; generated API reference and translated pages are out of scope. The example inventory in section 5 shows 10 representative pages.

Objectives:

  1. Produce a complete inventory with one accountable owner per page.
  2. Rate each page for accuracy, freshness and usefulness against the criteria in section 2.
  3. Give each page a ROT verdict and one action from the agreed set: keep, update, merge, archive or redirect.
  4. Identify content gaps from support and search evidence.
  5. Produce a prioritised, owned remediation backlog with dates.

2. Method and criteria

2.1 Inventory fields

FieldDefinitionSource
Page IDStable audit ID, CA-NNNAssigned in this audit
URL or pathPublished URL or source pathSite map or repository
TypeTutorial, How-to guide, Reference, Explanation, or another declared type (FAQ, release notes, landing page)Page front matter or auditor judgement
OwnerNamed person accountable for the pageCODEOWNERS file or docs owner assignment
Last verifiedDate an SME last confirmed the content as accurate (not the last edit date)Page metadata or review records
Usage signalAggregate monthly page views from privacy-respecting measurementDocs metrics source (section 2.3)
Feedback signalShare of "Was this page helpful?" answers that are positive, with the response countAggregate feedback counts
AccuracyRating from section 2.2SME spot check or task test
ROT verdictNone, Redundant, Outdated or TrivialSection 2.2
ActionKeep, Update, Merge, Archive or RedirectSection 6

2.2 Ratings

RatingValuesDefinition
AccuracyAccurateAll checked claims and steps are true for the current version
AccuracyPartly accurateAt least one claim or step is wrong but the page's core is correct
AccuracyOutdatedDescribes a previous version, a removed feature or a superseded process
AccuracyInaccurateCore content is wrong and a reader following it would fail
ROTRedundantAnother page covers the same need; keeping both splits maintenance and search results
ROTOutdatedContent no longer matches the product, process or policy
ROTTrivialNo reader need: internal notes, empty stubs, placeholders, event pages long past
ROTNonePage is needed, unique and current enough to keep
FreshnessFresh / StaleStale when the last verified date is older than the verify interval ([12] months) on the snapshot date

2.3 Usage and feedback signals: privacy rules

  • Use aggregate counts only: page views per page per month, positive and negative feedback counts, zero-result search terms, and support ticket tags. Never collect or store names, email addresses, IP addresses or device identifiers for an audit.
  • Prefer cookieless, first-party measurement, or server log counts that are aggregated and stripped of identifiers before analysis.
  • Respect consent choices and the Global Privacy Control (GPC) signal where your measurement depends on them.
  • Treat low-traffic numbers with care: a reference page read by ten administrators a month can still be essential.
  • Signals inform the verdict; they never decide it alone. A page with no traffic may be essential, and a page with high traffic may be harmful if inaccurate.

2.4 Accessibility signals

Record for each page whether automated checks found accessibility issues mapped to WCAG 2.2 (for example missing alt text under 1.1.1 Non-text Content, or vague link text under 2.4.4 Link Purpose (In Context)). The audit notes counts; fixes go through the Docs Review Checklist (docs/docs-review-checklist).

3. Roles and schedule

RoleResponsibilityName
Audit leadBuilds the inventory, runs calibration, writes the findings[@audit-lead]
AuditorsRate pages against section 2[@auditor-1], [@auditor-2]
SMEsConfirm accuracy for their product areas[@sme-orders], [@sme-checkout]
Support leadSupplies top ticket themes and deflection candidates[@support-lead]
Docs ownerApproves verdicts, assigns remediation owners[@docs-owner]
MilestoneDate
Scope and method approvedYYYY-MM-DD
Inventory snapshot takenYYYY-MM-DD
Calibration session (all auditors rate the same 5 pages)YYYY-MM-DD
Ratings completeYYYY-MM-DD
Findings and backlog issuedYYYY-MM-DD
Remediation complete (target)YYYY-MM-DD

4. Audit process

Steps in practice:

  1. Export every published page from the source repository and compare with the generated site map to catch orphans and pages missing from the build.
  2. Join the aggregate signals for a fixed period (for example the last [3] full months) so seasonal effects do not distort single pages.
  3. For each page, open the rendered version, read it, check its type, and record the owner and last verified date from metadata.
  4. Ask the SME to spot check claims on pages rated Partly accurate or worse, and on every page with high usage.
  5. Apply section 6 to reach one action per page. Record the reason in one sentence.

5. Content inventory

Snapshot date for the example rows: 2026-06-30 (the Q2 2026 audit that the Docs Metrics Report (docs/docs-metrics-report) example builds on). Verify interval: 12 months, so a page is stale when last verified before 2025-06-30.

Page IDURL or pathTypeOwnerLast verifiedViews per monthHelpful (responses)AccuracyROT verdictActionReason
CA-001 (Example)/docs/quickstartTutorial[@dev-rel]2026-05-124,21082% (310)AccurateNoneKeepPrimary entry point, current and well rated
CA-002 (Example)/docs/how-to/receive-order-eventsHow-to guide[@sme-orders]2026-06-201,96088% (142)AccurateNoneKeepReviewed this month with a task test
CA-003 (Example)/docs/how-to/configure-webhooks-legacyHow-to guide[@sme-orders]2024-11-0361041% (58)OutdatedRedundantMergeDuplicates CA-002 with the old console path
CA-004 (Example)/docs/reference/orders-apiReference[@sme-orders]2026-05-303,05079% (96)AccurateNoneKeepMatches the current API description
CA-005 (Example)/docs/reference/checkout-api-v1Reference[@sme-checkout]2025-02-1414035% (17)OutdatedOutdatedArchiveCheckout API v1 reached sunset; keep as archived version
CA-006 (Example)/docs/explanation/webhooks-explainedExplanation[@sme-orders]2025-06-0172052% (39)Partly accurateOutdatedUpdateRetry model description predates the delivery service change
CA-007 (Example)/docs/how-to/export-orders-csvHow-to guide[@sme-orders]2025-04-2288052% (61)Partly accurateOutdatedUpdateStep 3 refers to a renamed menu; export limit changed
CA-008 (Example)/docs/release-notes-2023Release notesUnassigned2023-12-1835n/a (0)OutdatedTrivialArchiveNo reader need; history kept in the changelog
CA-009 (Example)/docs/faqFAQ[@support-lead]2025-01-101,15047% (88)Partly accurateRedundantMergeAnswers duplicate troubleshooting and how-to pages
CA-010 (Example)/docs/getting-startedTutorialUnassigned2023-05-0230030% (22)InaccurateRedundantRedirectOld duplicate of CA-001 with broken steps
[CA-NNN][Path][Type][@owner]YYYY-MM-DD[Number][Percent (count)][Rating][Verdict][Action][One sentence]

Accessibility and quality signals per page (from automated checks on the snapshot date):

Page IDBroken linksLint errorsAccessibility issues (WCAG 2.2 criterion)
CA-003 (Example)253 images without alt text (1.1.1)
CA-007 (Example)011 vague link text (2.4.4)
CA-009 (Example)40Skipped heading levels (1.3.1)
CA-010 (Example)372 images without alt text (1.1.1)
[CA-NNN][Number][Number][Issues]

6. Verdict and action rules

ActionUse whenWhat happens to the URLFollow-up
KeepNeeded, unique, accurateUnchangedConfirm owner and next verify date
UpdateNeeded and unique, but partly accurate or staleUnchangedRemediation item with SME review
MergeOverlaps a better page but holds some unique contentPermanent redirect to the target pageMove unique content first, then redirect
ArchiveDescribes a retired version or has historical value onlyMoved to an archive section marked as not maintained, or removed with a redirect to the successorBanner stating the archive status and the current alternative
RedirectDuplicate with nothing unique worth keepingPermanent redirect to the replacementUpdate inbound links in the docs set

Never delete a public URL without a redirect or an explicit "gone" response: readers, search engines and support macros link to it.

7. Findings summary

Figures for the 10 example pages in section 5:

MeasureCountShare
Pages assessed10100%
Action: Keep3 (CA-001, CA-002, CA-004)30%
Action: Update2 (CA-006, CA-007)20%
Action: Merge2 (CA-003, CA-009)20%
Action: Archive2 (CA-005, CA-008)20%
Action: Redirect1 (CA-010)10%
ROT verdict other than None770%
Accuracy: Accurate330%
Accuracy: Partly accurate330%
Accuracy: Outdated330%
Accuracy: Inaccurate110%
Stale (last verified before 2025-06-30)7 (CA-003, CA-005 to CA-010)70%
Pages without an owner2 (CA-008, CA-010)20%
Monthly views on Keep pages9,220 of 13,05570.6%

Key findings:

  1. Example: Usage is concentrated: the three Keep pages carry 70.6% of monthly views, so remediation should protect those pages first and remove the noise around them.
  2. Example: Freshness is the main weakness: 7 of 10 pages have not been verified in the last 12 months, and every stale page is rated below Accurate.
  3. Example: Duplication confuses readers: three Redundant pages (CA-003, CA-009, CA-010) compete with better pages, and all three have helpful ratings under 50%.
  4. Example: Two pages have no owner, which explains why they decayed.
  5. Example: The FAQ mixes troubleshooting, how-to and reference content; splitting it follows the Diátaxis forms.

8. Content gaps

Gap IDEvidenceMissing contentProposed typePriority
GAP-001 (Example)112 zero-result searches for "rotate secret" in the period (aggregate count)How to rotate a webhook signing secret without downtimeHow-to guideHigh
GAP-002 (Example)Support ticket tag "refund webhook" among the top 10 themesEvent payload reference for order.refundedReferenceHigh
GAP-003 (Example)New feature "partial captures" released without docsExplanation of partial capture statesExplanationMedium
[GAP-NNN][Evidence][Content][Type][High / Medium / Low]

9. Remediation backlog

Item IDPage or gapActionWork descriptionOwnerEffortPriorityDueStatus
REM-001 (Example)CA-010RedirectRedirect /docs/getting-started to /docs/quickstart; update 12 inbound links[@docs-eng]SP1YYYY-MM-DDOpen
REM-002 (Example)CA-003MergeMove the legacy console note into CA-002, then redirect[@sme-orders]SP1YYYY-MM-DDOpen
REM-003 (Example)CA-009MergeMove answers into troubleshooting and how-to pages; redirect the FAQ anchors[@support-lead]MP1YYYY-MM-DDOpen
REM-004 (Example)CA-007UpdateFix menu path and export limit; task test[@sme-orders]SP2YYYY-MM-DDOpen
REM-005 (Example)CA-006UpdateRewrite retry model section; SME review[@sme-orders]MP2YYYY-MM-DDOpen
REM-006 (Example)CA-005ArchiveMove to archive with banner pointing to v2 reference[@docs-eng]SP3YYYY-MM-DDOpen
REM-007 (Example)CA-008ArchiveRemove from navigation; history stays in the changelog[@docs-eng]SP3YYYY-MM-DDOpen
REM-008 (Example)GAP-001CreateWrite the secret rotation how-to[@author]MP1YYYY-MM-DDOpen
REM-009 (Example)GAP-002CreateAdd order.refunded to the event reference[@sme-orders]SP1YYYY-MM-DDOpen
REM-010 (Example)GAP-003CreateWrite partial capture explanation[@sme-checkout]MP2YYYY-MM-DDOpen
[REM-NNN][CA-NNN or GAP-NNN][Action][Work][@owner][S / M / L][P1 / P2 / P3]YYYY-MM-DD[Open / In progress / Done]

The example backlog has 10 items: 7 from the inventory (every page without a Keep action) and 3 from gaps; 5 are P1, 3 are P2 and 2 are P3. Every updated or new page passes the Docs Review Checklist (docs/docs-review-checklist) before it closes.

10. Redirect and archive plan

Old URLNew URLTypeReasonBacklog item
/docs/getting-started (Example)/docs/quickstartPermanent (301 or 308)DuplicateREM-001
/docs/how-to/configure-webhooks-legacy (Example)/docs/how-to/receive-order-eventsPermanentMergedREM-002
/docs/faq (Example)/docs/troubleshootingPermanentMerged; per-answer anchors map to their new troubleshooting or how-to pages, the bare URL goes to troubleshootingREM-003
/docs/reference/checkout-api-v1 (Example)/docs/archive/checkout-api-v1PermanentArchived versionREM-006
[Old path][New path][Permanent / Gone][Reason][REM-NNN]

Archive rules:

  • Archived pages carry a banner that states they are not maintained and links to the current alternative.
  • Archived pages are excluded from site search by default and marked so that search engines do not index them, unless a legal or contractual reason requires them to stay discoverable.
  • Redirect rules follow the information architecture policy (docs/information-architecture).

11. Governance and next audit

ControlRuleOwner
OwnershipEvery page has a named owner in metadata; the build fails without one[@docs-eng]
Verify intervalEach page records last verified date; pages past [12] months appear in the monthly docs metrics report[@docs-owner]
New contentNew pages declare a Diátaxis type and pass the review checklist[@docs-lead]
Duplicate preventionSearch existing pages before creating; reviewers check for overlap[@editor]
RetirementProduct deprecations trigger an archive or update item for affected pages[@product-owner]
Next auditFull audit [annually]; light audit of top 20 pages by views [quarterly][@audit-lead]

Progress on the remediation backlog and the freshness share is reported in the Docs Metrics Report (docs/docs-metrics-report).

12. Glossary and references

12.1 Glossary

TermMeaning in this audit
Content inventoryList of every page in scope with its attributes
ROTRedundant, outdated or trivial content
VerdictROT classification for a page
ActionWhat happens to the page: keep, update, merge, archive or redirect
Last verifiedDate an SME last confirmed accuracy, distinct from the last edit
Orphan pagePublished page no navigation or other page links to
CalibrationSession where auditors rate the same pages and agree on criteria

12.2 References

ReferenceVersion or date checkedUse
ISO/IEC/IEEE 26511:2018, Systems and software engineering: Requirements for managers of information for users of systems, software, and servicesEdition 2, 2018; reviewed and confirmed 2024Management and quality evaluation activities, structure only
ISO/IEC/IEEE 26513:2017, Requirements for testers and reviewers of information for usersEdition 1, 2017; second edition at final draft stage when checked 2026-10-24Review concepts, structure only
W3C, Web Content Accessibility Guidelines (WCAG) 2.2, https://www.w3.org/TR/WCAG22/W3C Recommendation, 12 December 2024Accessibility signal mapping
Diátaxis, Daniele Procida, https://diataxis.fr/Checked 2026-10-24Content type classification
W3C, Global Privacy Control (GPC), https://www.w3.org/TR/gpc/W3C Working Draft, as published in September 2026Honouring the opt-out signal in measurement
[Internal docs metrics definitions][Version][Signals used]

Standard and licence note

Structure aligned with the management and quality-evaluation activities of ISO/IEC/IEEE 26511:2018 and the review concepts of ISO/IEC/IEEE 26513:2017. Only standard names and general concepts are referenced; no ISO text, table, definition or clause wording is reproduced. Accessibility signals cite WCAG 2.2 success criteria by number and short name only. Content types follow the four forms of the Diátaxis framework by Daniele Procida (https://diataxis.fr), licensed under CC BY-SA 4.0; this template uses the type names for classification and does not adapt Diátaxis text. The ROT method is common industry practice described here in original words. All example data refers to a fictional company. This template is original text written for this collection. Check the current official versions of every cited standard before use. Template licence: MIT.

関連テンプレート