Automated Audit Scheduling

Automated audit scheduling lets Hyperdocs run a Docs Audit on a recurring schedule without any manual intervention. Instead of remembering to check your documentation health after every sprint or release, you configure a frequency once and audits run in the background automatically — keeping your documentation health score and gap reports fresh on a cadence that matches your team's workflow.

How It Works

When scheduling is enabled, Hyperdocs queues a Docs Audit job at the interval you configure. Each scheduled run goes through the same five-stage pipeline as a manual audit — loading your documentation, fetching the repository file tree, analyzing source files, comparing docs against the codebase, and scoring coverage and staleness. The result is saved to your audit history and a notification appears in the header when the run completes, exactly as it does for a manual run.

Scheduled runs appear in the Audit history sidebar with a Scheduled trigger label, so you can distinguish them from runs you started manually or runs triggered automatically by a commit. Every past run — regardless of trigger type — is stored and can be loaded at any time by clicking its row in the sidebar.

Benefits

Scheduling audits on a cadence gives your team a consistent, low-effort way to stay on top of documentation drift:

•No manual reminders needed — once the schedule is saved, audits run hands-free. You do not need to remember to check after each release.

•Consistent health tracking — because every scheduled run is saved to audit history, you can compare scores over time and see whether documentation coverage is improving or declining.

•Early detection of drift — a regular cadence surfaces undocumented areas and outdated claims before they accumulate into a large backlog, which is harder to address all at once.

•Complements Git Sync — scheduled audits check the entire codebase against your docs in one pass, which is more efficient than reviewing many individual commits one by one when changes have piled up.

Where to Find It

The scheduling controls live inside the Docs Audit page, in the Automated audits panel. To get there:

•Open your admin dashboard and select Docs Audit from the sidebar.

•Scroll down past the audit results to find the Automated audits panel. It sits below the main results area and is always visible on the page, whether or not an audit has been run.

Frequency Options

Two frequency modes are available. You select one using the Every N days or Weekly buttons inside the panel.

Every N Days

Runs the audit once every N days on a rolling interval. Enter a number between 1 and 90 in the Run every ___ day(s) field. For example, entering 7 runs the audit once a week from the day you save the schedule. This mode is useful when you want a fixed cadence regardless of the day of the week.

Weekly

Runs the audit once a week on a specific day and time. Select the day using the day buttons (Mon through Sun), then set the time using the time field. The time is interpreted as server time, which is noted next to the field. This mode is useful when your team reviews documentation health on a fixed day — for example, every Monday morning before a sprint starts.

Setting Up a Schedule

•Open your admin dashboard and navigate to Docs Audit in the sidebar.

•Confirm that a GitHub repository is connected. Automated audits require a linked repository — if none is connected, set one up first from the Git Sync section.

•Scroll to the Automated audits panel and turn on the toggle at the top of the panel to enable scheduling.

•Select a frequency mode: click Every N days to run on a rolling interval, or Weekly to run on a specific day of the week.

•If you chose Every N days, enter a number between 1 and 90 in the interval field.

•If you chose Weekly, select the day of the week using the day buttons, then set the time of day using the time field.

•Click Save schedule to apply your configuration. The schedule becomes active immediately.

•To disable scheduling at any time, return to the Automated audits panel and turn the toggle off, then save.

Viewing Scheduled Run Results

Every completed scheduled run is saved automatically and appears in the Audit history sidebar on the left side of the Docs Audit page. Each row in the sidebar shows:

•The trigger type badge — Scheduled for automated runs, Manual for runs you started yourself, and Auto for runs triggered by a commit.

•The health score for that run, color-coded green (75–100), amber (50–74), or red (0–49).

•The commit message the audit was based on, if one was available at the time.

•The date and time the run completed.

Click any row in the sidebar to load that run's full report — including the health score, undocumented areas, outdated claims, and run details — without overwriting the latest results.

Plan Requirements

Automated audit scheduling requires a plan that includes the automation feature. The Automated audits panel is visible on all plans, but clicking Save schedule on an ineligible plan opens an upgrade prompt instead of saving the configuration. Upgrading your plan resolves the restriction immediately.

Only Admins can configure or modify the schedule. Editors and Viewers can see the Automated audits panel but the controls are read-only for them.

Each scheduled audit run uses credits from your plan's balance, the same as a manual run. The Run details panel on any completed audit shows how many credits were used and how many remain. If your credit balance is exhausted, the scheduled run stops and you are prompted to upgrade before the next run can proceed.