Skip to main content
Shakewell

Explainer

Why Authoring Teams Need a CCMS

The case for a CCMS is usually made to the CIO. It should be made to the people who write the manuals, because they are the ones paying for its absence every week.

The Cost

The Week Without One

Ask an authoring team where the week went and the answer is rarely “writing.” A caution changed, so someone opened the forty manuals it appears in, found it in thirty-seven of them, and hoped the other three were retired. The procedure that differs by one torque value now exists as two documents. An author fixing one doesn't always know the other exists, so they drift apart. A step gets clarified in one. A tool number gets corrected in the other. Nobody compares them again, and by the third revision the two procedures differ in a dozen places and only one of those differences was ever intended. The translation vendor invoiced for the whole chapter again, because nobody could prove that only one paragraph changed. Review went out as an attachment, and three reviewers now hold three copies, each believing they are current.

None of this is carelessness. It is competent people doing bookkeeping that the tools cannot do for them. A document-based workflow has no idea that the caution on page 212 of one manual is the same caution as page 48 of another. It has no way to record which variant a paragraph applies to except by keeping a second paragraph.

So the knowledge lives with people. The senior writer who knows which manuals share the hydraulic warning. The spreadsheet that maps variants to documents, last updated by someone who left. And when the audit question arrives, which deliverables did the revised caution actually reach, the honest answer is manual searches and a compiled spreadsheet.

The Alternative

One Component, Many Publications

A single jigsaw piece being lowered into the one gap in an otherwise complete puzzle
One component, one place it lives. Every publication that needs the caution draws it from there instead of keeping a copy.

A component content management system starts from a different unit. Not the document but the piece: a procedure, a warning, a description, a table. Each piece is written once, carries its own identity, and is assembled into as many publications as need it. That single change in unit is where every practical benefit comes from.

The caution changes once, and every manual that uses it picks up the change on the next publish. Before the change is saved, the system answers “where is this used?” from its own index rather than from a search, so the impact is known before the edit, not discovered after. Variants stop being duplicate documents: the procedure is one component with applicability on the one step that differs, and the right version is filtered out at publish time. Translation is priced on the components that actually changed, because the system knows which those are. And review and approval attach to the component, so “who approved this warning, and when” is a query with an audit trail instead of an email thread.

None of this requires a large team. It requires auditable reuse, and that's what a CCMS actually supplies. A CCMS makes the relationship between components something the system holds: the caution is one component with one identity, and every manual that needs it holds a reference to it rather than a copy. The reference is what makes reuse real.

One caution of our own: a CCMS amplifies your information architecture, including a bad one. The decision about what a component is, how big, how named, how applicability is expressed, is upfront work that no tool does for you. Done well, it is what turns a week of bookkeeping back into a week of writing.

FAQ

Questions We Hear

Isn't this just version control?

Version control is part of it, not an alternative to it. A CCMS versions every component, records who changed it and when, and lets you compare or roll back any of them. What it adds is that the versions are of the caution, not of the forty files the caution appears in. So the question "which manuals still carry the old wording?" has an answer, and "what changes if I revise this?" is known before the save. Version control on files can tell you that a file changed. A CCMS can tell you what that change reached.

We already reuse content. We copy and paste it. What's the problem?

Copying works right up to the first change. After that, every copy is a separate maintenance obligation, and the only record of where the copies went is memory. The problem is not the reuse. It is that copy-and-paste reuse leaves no trace, so the cost of keeping the copies in step lands on people instead of the system.

Does a CCMS replace our authoring tool?

No. The CCMS is the repository and the rules; authors keep working in a structured editor that connects to it.

How big does a team need to be before a CCMS pays off?

Size is the wrong measure. The test is reuse depth: how many publications share content, how many variants a procedure has, how often a change in one place must be reflected in others. A three-person team maintaining twelve variant-heavy manuals feels the pain long before a thirty-person team with flat, one-off documents does.

Get In Touch

Where Does Your Week Go?

We start by mapping the reuse that is already happening by hand: the shared cautions, the variant procedures, the paragraphs that travel by copy. That map tells you whether a CCMS pays off, and what it needs to look like if it does.