Skip to main content
ShakewellContact

Buyer's Guide

CCMS Requirements: A Buyer's Checklist

Write your requirements before you watch a demo. Fifteen questions to put to any component content management system, each with the reason to ask it.

The Short Answer

Requirements Come From Your Content

A demo shows what a system does well. A requirements list shows whether it does what you need. Write the list first, from your own content model, your outputs, and your review and compliance rules, then score each system against the same questions. The sections below group the questions by what they protect: the content, the change process, the outputs, and your way in and out.

This page assumes you already know why you want one. If not, start with what a CCMS is and why authoring teams need one. To separate it from web and document systems, see CCMS vs CMS and DAM vs DMS vs CCMS. Who should decide and fund the purchase is covered in buying publishing software. If you are on S1000D, choosing S1000D tools scores that toolchain layer by layer. For the standards themselves, see DITA and S1000D.

Content

What It Must Hold

  1. Content model support

    Ask: Which content models does the system support natively: DITA, S1000D, a custom XML schema, or all three? Which schema languages (DTD, XSD) does it validate against, and does it validate when an author saves, or only at publish?

    Why it matters: The model is the contract between authors and the system, and switching it later means converting everything. DITA 1.3 is the current OASIS version, and 2.0 is still in beta and not backward compatible (see DITA 2.0), so ask how the vendor plans to handle it. For S1000D, ask which issue is supported and whether business rules are enforced as authors work; what a CSDB is explains why. The DTD vs XSD note covers the schema question.

  2. Reuse and linking

    Ask: How does a publication point to a component: content references, keys, or something proprietary? Can the system list every place a component is used before you change it? What happens to a link when a component moves or is retired?

    Why it matters: Reuse by reference is the reason to buy a CCMS at all. If the system only copies, you have bought an expensive file share. Where-used reporting is how an editor knows the blast radius of a change. For the DITA mechanics, see maps, keys, and conref.

  3. Applicability and variants

    Ask: How are product variants, configurations, or effectivity expressed and filtered? Can one component carry several variants and be filtered at publish time? Can you preview a single variant?

    Why it matters: Variants are where copy-and-paste returns if the system handles them poorly. In S1000D programs applicability is part of the specification; see S1000D applicability.

  4. Metadata and taxonomy

    Ask: Can you define your own metadata fields and controlled vocabularies? Are they enforced, searchable, and available to filter publications and to drive workflow?

    Why it matters: Metadata is how a library of thousands of components stays findable and governable. A fixed set of fields that cannot be extended forces teams to hide meaning in file names.

  5. Search and discovery

    Ask: Can authors search by content, by metadata, and by structure (for example, every warning that mentions a given part)? Is search aware of versions and of what is checked out?

    Why it matters: Authors reuse what they can find. If search is weak, they write a new component instead, and the duplication you set out to remove grows back.

Control

How It Manages Change

  1. Versioning, branching, and baselines

    Ask: Is every component versioned? Can you branch for a parallel release, merge back, and see conflicts? Can you freeze a baseline and rebuild exactly what was published from it, years later?

    Why it matters: An audit or a field question about an old release is answered from the baseline, not from the latest version. Parallel revisions are routine for programs with overlapping releases; see branches, merges, and pinning and, for content that changes on a date, effective-dated publishing.

  2. Workflow and review

    Ask: Can you define your own states and routes (draft, technical review, approval, released)? Can reviewers comment on the rendered output rather than raw XML, and can review be assigned per component or per publication?

    Why it matters: Subject-matter experts rarely read XML. If review is painful they skip it or work from exported PDFs, and the comments never return to the source. Look at how the system treats contributors who are not writers; contributors and editors describes the roles.

  3. Audit trail

    Ask: Does the system record who changed, approved, or viewed what and when? Can the record be exported, and can it be edited by an administrator?

    Why it matters: Regulated and contract programs have to show how a published statement came to be. A trail that can be quietly edited is not evidence.

  4. Permissions and export control

    Ask: Can access be limited per person, per component, and per publication? Can content be marked with distribution or export-control statements that the system enforces? Where is data stored and processed, and who at the vendor can reach it?

    Why it matters: If your data is export-controlled, access control is a compliance question, not a convenience. The ITAR definition of technical data reaches maintenance and repair information; read ITAR technical data and distribution statements. Take written answers to your empowered official and counsel; this page is not legal advice.

  5. Translation management hooks

    Ask: Can the system send only changed components out for translation and bring them back? Does it track which language version matches which source version? Does it work with the translation tools and vendors you already use?

    Why it matters: Translation is often the first place the budget case for a CCMS is made, because unchanged components should not be paid for twice. It only works if the system knows what changed.

Output

How Content Gets Out and Around

  1. Publishing pipelines

    Ask: Which outputs are supported (PDF, web help, interactive manuals, data feeds)? Can you run and tune the pipelines yourself, or does every style change go through the vendor? Can a single source feed all of them?

    Why it matters: Outputs are where your customers see the result, and where lock-in often hides in proprietary stylesheets. The mechanics are in how XML becomes a PDF and single-source publishing.

  2. Integrations

    Ask: What APIs and connectors exist for your parts system, PLM, translation tools, identity provider, and delivery portal? Are the APIs documented, versioned, and available without a services engagement?

    Why it matters: A CCMS rarely stands alone. The cost of a missing integration is a person re-keying data between systems, which is the problem you were trying to remove.

  3. Hosting and operations

    Ask: Is it hosted by the vendor, by you, or both? Where does data live? What are the backup, recovery, upgrade, and downtime arrangements, and who pays for an upgrade that changes your content model support?

    Why it matters: A content system becomes operational infrastructure. Ask about the boring things: how a restore is tested, how upgrades are scheduled, and what happens if you stop paying.

Entry and Exit

Getting In, and Getting Out

  1. Import and migration of legacy content

    Ask: What formats can be imported, and what does the import do with structure, images, and cross-references? Can you try it on your own worst files? Who does the conversion work, and what is checked afterwards?

    Why it matters: Legacy content decides the schedule. Not all of it should be converted; see convert or ingest. A realistic view of your starting point comes from the readiness checklist. For a move between systems rather than from documents, see moving from one CCMS to another.

  2. Exit and export in open formats

    Ask: Can you export all of your content, with its history, metadata, links, and illustrations, in an open, documented format and without a fee? Does the export reproduce the structure, or flatten it? Will the vendor show you a real export from a test project?

    Why it matters: Your content outlives any system. Standards-based XML should leave as it came in; a vendor-specific container with your content trapped inside is lock-in. Ask this before signing, not at renewal.

The Test

Prove It With Your Own Content

A vendor's demo content is chosen to work. Send the same short brief to every finalist, with a sample from your own library, and ask them to run it live against a script you wrote. A good sample includes your hardest topic, a component reused in several places, a variant, an image-heavy section, and a file from the oldest part of your estate.

Script the tasks, not the screens: import the sample, make a change to a shared component and show where it is used, branch and merge, send a change through review, restrict one component to a named person, publish two outputs from the same source, and export everything in an open format. Score each task pass, partial, or fail, and note who operated the system. If the vendor's staff must drive every step, that tells you what your team's daily experience will be.

FAQ

Questions We Hear

What are the core requirements for a CCMS?

Support for your content model, component reuse with where-used reporting, versioning with branches and baselines, configurable workflow and review, role-based permissions, a publishing pipeline for your outputs, and an open-format export. Everything else on the checklist is a refinement of one of those, weighted by your program.

How does a CCMS work?

Authors write small components against a content model, and the system stores each one with its versions, metadata, and relationships. Publications are assembled from references to those components and built by a publishing pipeline into PDF, web, or other outputs. Our explainer on what a CCMS is covers the concept; this page covers what to ask of one.

What is CCMS software, and is it the same as a CMS?

CCMS software manages reusable components inside documents and manuals; a web CMS manages pages for a website. The two solve different problems, as the comparison of CCMS and CMS shows.

Are there guidelines for how to evaluate one?

No single standard governs CCMS selection. The practical guidelines are to write requirements from your own content model and outputs, score every vendor against the same list, and test with your own sample content in a scripted demo. The questions on this page are a starting point for that list.

Do the requirements differ for S1000D?

Yes. A CCMS that serves an S1000D program is expected to act as a CSDB, with applicability, business rule enforcement, and publication module handling. Our guides to the CSDB and to choosing S1000D tools cover those requirements, and the checklist above still applies on top.

Get In Touch

Writing the List Now?

Tell us what you manage, the standards you work to, and where it has to go. We can help you turn it into requirements and a test script.