mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
80e1e20c07
- Remove exclamation point in hidden-page-example.mdx - Replace 'click on' with 'click' in google-analytics.mdx - Replace 'open-source' with 'open source' in maintenance.mdx Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
39 lines
2.4 KiB
Plaintext
39 lines
2.4 KiB
Plaintext
---
|
|
title: "Maintenance"
|
|
description: "Keep your documentation accurate and up-to-date over time."
|
|
keywords: ["maintenance", "content lifecycle", "stale content"]
|
|
---
|
|
|
|
<Tip>
|
|
This page explains strategies for keeping your documentation accurate and valuable over time, from automated checks to content lifecycles.
|
|
</Tip>
|
|
|
|
## Automate what you can
|
|
|
|
Introduce automations where you can, such as:
|
|
|
|
- **Track stale content:** Run a script to flag important docs that haven't been updated in the last three months. Are they still accurate?
|
|
- **Automate documentation updates:** Build a workflow to automatically update documentation when code is merged with the [agent API](/guides/automate-agent).
|
|
- **Enforce standards with linters:** Use [Vale](http://Vale.sh) or [CI checks](/deploy/ci) to automatically catch formatting issues, writing style deviations, or missing metadata on every pull request.
|
|
|
|
## Set up a review process
|
|
|
|
Documentation might never be perfect, and that's okay. You should have a threshold of acceptance where documentation is functional and useful.
|
|
|
|
Balance efficiency with quality:
|
|
|
|
- **Focus on high-impact docs.** Not every page needs regular updates. Make sure the most important pages are reviewed regularly for accuracy and relevance.
|
|
- **Leverage your community.** If your docs are open source, empower users to flag issues or submit fixes via pull requests. This builds trust and keeps content fresh.
|
|
|
|
## Know when to rewrite
|
|
|
|
Over time, documentation naturally accumulates caveats and workarounds. When incremental fixes create more confusion than clarity, a full overhaul might be the best option.
|
|
|
|
- **Plan for periodic resets.** A major cleanup, especially if best practices or the product itself has evolved significantly, saves time for your team and your users.
|
|
- **Start with a structured audit.** Interview support teams, analyze user feedback, and document what is missing, misleading, or redundant before rewriting.
|
|
- **Complete rewrites in focused sprints.** A full overhaul doesn't have to happen all at once. Prioritize sections with the biggest impact.
|
|
|
|
## Wrong docs can be worse than no docs
|
|
|
|
Outdated or misleading documentation wastes users' time and erodes trust. In cases where a page is completely inaccurate and unfixable in the short term, it's often better to remove it entirely. Users will appreciate having less information over having wrong information.
|