What is a CCMS, and does your team need one?
A component content management system, CCMS for short, manages documentation as pieces rather than files. This page explains what that means, what it buys you, and how to tell whether your team has reached the point of needing one.
Pieces, not files
A web CMS manages pages. A document management system manages files. A CCMS manages the pieces inside the documents: a procedure, a warning, a specification table, a product description. Each piece has one source, and a manual is an arrangement of pieces.
That is the whole idea. Everything else follows from having one source for each piece.
What follows
Once a piece has one source, a CCMS can do things a file never could:
- Reuse: a safety warning written once appears in forty manuals, and a correction fixes all forty.
- Variants: one source produces the manual for each model, with conditions deciding what each reader sees.
- Versions: every change is kept, and a release records exactly which version of each piece shipped.
- Translation: only the pieces that changed go to the translator, and the manual in every language is assembled from the same arrangement.
- Publishing: the same pieces become PDF, HTML, or whatever the reader needs, without a second copy to maintain.
Who needs one
The signs are consistent across industries. You maintain the same warning in more than one document and they have drifted apart. You ship the same product in several models or languages and each manual is its own file. Someone has asked which version of a manual went out with a particular serial number, and the answer took a day. Your translation bills are high because whole documents go out when a paragraph changed.
Machinery, medical devices, automotive and electronics teams reach this point early, because regulation makes the questions unavoidable. Software teams reach it when the product has a second edition.
The usual options
Most CCMS fall into three families. DITA-based systems store the DITA XML standard and inherit its ecosystem and its learning curve. Systems with their own XML model, common in German-speaking manufacturing, pair a desktop client with deep variant handling. Browser-based systems, Paligo and Contentry among them, keep the structure but drop the XML from the writer's view.
Contentry is in the third family and takes the idea furthest: the structure is in the editor, you write what the reader sees, and the assistant is part of the studio rather than a module.
What to look for
Whether a writer can be productive in the first week without a course. Whether reuse is visible while writing or only in a report. Whether translation round-trips without losing formatting. Whether a release records what shipped. Whether the PDF layout can be changed by the people who write the manual. And whether the price is published.