Audit and keep your docs healthy
Keeping docs current is as much about the pages that already drifted as the pages that might drift soon. A large corpus accumulates stale steps, off-style prose, duplicate pages, and a structure that no longer matches how the product works. Promptless treats that backlog as documentation work like any other. Rather than a single capability called “audit,” it combines the tools in this section to surface what’s wrong, fix it at scale, and keep it fixed.
This page maps three recurring health jobs to the capability that handles each one. Most of them lean on Deep Analysis, which is heavier and slower than a routine trigger — a run can take several hours and produce many suggestions — so reach for these jobs when the cleanup genuinely calls for that scope.
Audit existing content for staleness
Section titled “Audit existing content for staleness”Before you can fix a large docs set, you need to know which pages are wrong. Deep Analysis is built for exactly this scope because it reviews your configured source repos, audits your existing docs for consistency, accuracy, and style compliance, and returns a coordinated set of suggestions rather than a single edit. Its Audit for consistency template reviews a collection for consistent terminology, formatting, and structure, so the audit pass produces reviewable diffs instead of a report you still have to act on.
Remediate and restandardize legacy pages
Section titled “Remediate and restandardize legacy pages”Remediation is where most brownfield debt lives, such as pages that are accurate but written against an old pattern, or a section that needs rewriting to match stronger examples elsewhere.
- Use Deep Analysis to refactor or rewrite a whole section — its Refactor a bad section of docs template improves an existing section using another set of docs as the model, so divergent legacy pages converge on one pattern.
- Use Vale integration to hold that pattern going forward. When Vale is configured for a collection, Promptless lints prose before creating suggestions and fixes findings according to your config’s alert level, so restandardized pages stay on-style instead of drifting again on the next edit.
- Use Doc Detective to keep the procedures on those pages true, not just their prose. When it’s enabled on the doc collection, the procedures remediation adds or rewrites become executable checks, and Promptless updates those checks as the product changes. That way, a stale workflow fails a test wherever coverage exists.
Restructure your information architecture
Section titled “Restructure your information architecture”Sometimes the pages are fine but the shape is wrong, like when sections have grown organically and the structure no longer matches what readers need. Restructuring is a coordinated move, and Promptless handles it in two parts:
- Use Deep Analysis to plan and execute the content moves — restructuring a section to match a new pattern is one of its core use cases, and it plans the work across pages before any edits land.
- Preserve URLs and redirects so the restructure doesn’t break inbound links. Redirect handling belongs to your documentation platform and host, so map every changed path to its new home and add a permanent redirect, then crawl for broken links before and after the move.
Where to start
Section titled “Where to start”Planning a large audit, remediation, or restructure and want help scoping it? Contact help@gopromptless.ai.