Docs Audit

Docs Audit gives you a complete analysis of your documentation, scoring it against a customizable style guide. Style guides are a set of standards and rules for writing API documentation that ensures consistency and usability for developers.

How the Linter Works

ReadMe‘s Linter applies your custom style guide on the page level, using AI-powered prompts to raise issues while you write and edit content. You can configure these rules for the following categories:

• Style Guide: Ratings that measure how well content aligns with your company‘s definition of good documentation.
• Errors: Objective, critical issues that must be fixed (e.g., spelling mistakes, incorrect grammar).
• Warnings: Subjective issues that may require editorial judgment (e.g., contraction usage, vague language).

The Linter can be run before saving page content, allowing you to check your work before saving changes.

How Docs Audit Works

While the Linter works at a page level, Docs Audit scales these checks across all of your documentation. By aggregating results and analyzing ever page, Docs Audit helps you:

• Identify gaps, inconsistencies, and patterns.
• Find areas where content doesn‘t align with your style guide.
• Improve documentation quality and consistency.

Together, Docs Audit and the Linter are a powerful system for reviewing, scoring, and improving your documentation. The Linter ensures individual pages meet your standards, while Docs Audit provides the big-picture analysis you need to deliver a consistent, high-quality experience across your entire developer hub.

FAQ