Documentation maintenance · quality & style
Docs that stay true to the product.
Documentation ages faster than code: features change, screenshots drift, terminology diverges, links break. This service takes an existing set, up to 300 pages, and brings every page back in line with the product and your writing style, in one month.
30-day delivery · 2 free revisions
What changes for your team
- Every page accurate against the current release, no more support tickets caused by the docs themselves.
- One voice: terminology, tone and formatting aligned with your style guide across the whole set.
- No dead ends: broken links, stale screenshots and outdated pages found and fixed or retired.
- A prioritised report of what we changed, what we retired, and what deserves a rewrite next.
Deliverables
- Page inventory with a status per page: kept, fixed, retired
- Reviewed changes on every fixed page, accuracy, style, terminology, links, screenshots
- Retired pages with redirects in place
- Change log and a next-steps list (pages that deserve a rewrite)
Standards, tools and formats
- Style-guide alignment
- Terminology management
- Link & screenshot checks
- Docs-as-code · Git · CI
- GitBook · MkDocs · Docusaurus · Confluence
- Diátaxis
- Vale · linting
- English · French
How the engagement runs
- Inventory & audit We list every page, check it against the current product and your style guide, and grade it: fine, fix, retire. You get the inventory in week one.
- Fix Accuracy fixes, style and terminology alignment, link and screenshot repair, page by page, as reviewed changes in your repo or platform.
- Retire & redirect Pages that no longer match the product are retired with redirects, so nobody lands on a wrong answer.
- Hand over A change log of everything touched, the updated inventory, and a short list of pages worth a full rewrite, with a quote if you want one.
Questions
What counts as a page?
One article or topic in your docs, whatever the platform. Up to 300 pages in the base price; larger sets are quoted in blocks of 300 at the same rate.
Do you rewrite pages?
No, this is maintenance: we fix, align and retire. Pages that need a rewrite are listed with a quote; you decide.
Which style guide?
Yours if you have one. If not, we apply a standard one (Google or Microsoft style) and hand it to you as your house style.
Can you make this recurring?
Yes, the monthly plans keep the docs maintained with every release, at a lower rate than one-off passes.