AI

Integrate Artificial Intelligence into your workflows to improve content, shorten time to publish, and guide users to answers in your platform. Enterprise users have full access to ReadMe's AI tooling across their entire Enterprise Group, ensuring that documentation works for both humans and AI agents.

Two Enterprise-level features are the Group-Level Linter and recurring Docs Audit, which runs your documentation standards against your full collection of documentation.

---

Group-Level Linter

The Linter automates content validation by checking your documentation against a customizable style guide as you write and edit. You can configure rules across the following three categories to enforce consistent word choice, formatting, tone, and best practices:

• Style guide ratings

• Objective errors

• Subjective warnings

Broken link detection is included by default, and any issues flagged by the Linter can be resolved automatically using the AI Agent.

You can apply Linter Rules at the group level from your Enterprise Group Dashboard. You can access the Linter Rules from the left navigation nested under Group Settings.

---

Docs Audit

Docs Audit gives you a complete analysis of your documentation by running your style guide against every page in your project. It aggregates linter results to identify gaps, inconsistencies, and areas where content doesn't align with established documentation standards. Enterprise customers can schedule recurring audits and export the results for external analysis.

Enable Docs Audit

You can access Docs Audit from the left navigation bar while in Preview mode. You are prompted to run your first documentation audit against your Linter Rules, generating an initial report of how your existing docs perform against them.

📘

You must have Linter Rules set up before running your first Docs Audit.

Set Up Recurring Audits

To schedule automated recurring audits, select Schedule daily run from within Docs Audit. Click the Enable scheduled audits toggle, select your desired audit time, choose which documentation versions to include, and select Save Schedule.

---

ReadMe AI Features