Audit and keep your docs healthy
Keeping docs current covers the pages that already drifted as well 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. The capabilities on these audit pages work together to find what’s wrong, fix it at scale, and keep it fixed.
Most of these jobs lean on Deep Analysis, which is heavier and slower than a routine trigger. A run can take several hours and produce many suggestions, so use it when the cleanup calls for that scope.
Use cases
Section titled “Use cases”Each recurring health job maps to the capabilities that handle it:
| Problem | Capabilities that handle it |
|---|---|
| You don’t know which pages in a large docs set are stale or inconsistent. | Deep Analysis, with its Audit for consistency template |
| Legacy pages are accurate but follow an old pattern. | Deep Analysis, Vale, and Doc Detective to rewrite the pages and keep them current |
| The structure no longer matches what readers need. | Deep Analysis and your redirects to move content without breaking links |
| You don’t know whether your docs answer the questions readers ask. | Docs evals to grade a model’s answers and open a docs task for each failure |
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 handles this scope. It reviews your configured source repos and audits your existing docs for consistency, accuracy, and style compliance, then returns a coordinated set of suggestions. Its Audit for consistency template reviews a collection for consistent terminology, formatting, and structure. The audit produces reviewable diffs, so its findings arrive as fixes you can accept or edit.
Remediate and restandardize legacy pages
Section titled “Remediate and restandardize legacy pages”Remediation is where most brownfield debt lives. Examples include 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. Divergent legacy pages then converge on one pattern.
- Use Vale integration to hold that pattern going forward. Promptless lints prose with Vale before it creates a suggestion and fixes findings according to your config’s alert level. Restandardized pages then stay on-style through later edits.
- Use Doc Detective to keep the procedures on those pages accurate. When your repository uses Doc Detective, the procedures that remediation adds or rewrites become executable tests. Promptless updates those tests as the product changes. A stale workflow then 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: sections have grown organically, and the structure no longer matches what readers need. Restructuring is a coordinated move 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. It plans the work across pages before any edits land.
- Preserve URLs and redirects so the restructure keeps inbound links working. When a suggestion moves or renames pages, it adds a permanent redirect for each changed URL. It also points the collection’s links at the new pages. 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.