Maintainability (noun)
The degree to which something can be kept correct and current, with reasonable effort and risk, as its subject changes.
About Maintainability
Suppose our organization makes cloud accounting software. We publish our docs to a web portal and to in-product help, and an AI assistant answers customer questions from the same content.
One of our procedures explains how to export invoices. In an upcoming release, the product team decides to move the Export button from the Billing page to the Reports page. If our documentation is designed to be maintainable, that change takes one quick edit.
Our procedures are single-sourced, which allows us to reuse them systematically in every channel we support instead of copying and pasting them into multiple files. We store reusable piece of content in our component content management system (CCMS), where we also tag them with metadata identifying the part of the product they describe, so before the release ships, our writers can efficiently locate every topic tagged for invoice exports without relying on memory.
Imagine a writer previously created a troubleshooting article but typed out the instructions manually instead of linking to the central, reusable version. Because they didn't tag the article, writers might not find it when searching for content to update before a new release. In this scenario, once the update goes live, the website will contain two different answers to the same question and only one of them will be correct.
