Single-Source Publishing (SSP): you can achieve this in several ways:
(A) OFFICIAL SSP - a Content Management System (CMS)
(B) SSP approach – with e.g. All-In-One Documents and Illustrations
(A) OFFICIAL SSP - a Content Management System (CMS)
(A1) The principle of SSP
Content Management: It's about keeping track of huge amounts of information.
This is where Single-Source Publishing (SSP) is essential:
Single-Source Publishing: Every TOPIC (e.g. image, paragraph in document, table) stored in one place)
The benefits are clear, but there are also challenges:
You cannot use MS Word, but must invest in SSP software for everyone who needs to process documentation.
Dividing all source material into topics is difficult:
No problem with Chapter 1: General Safety. You can reuse IT in all guides.
For example, if you have three product variants, you can often reuse a lot in Chapter 2: Product Description. But for the features that are not found in all three variants, generate product-specific topics.
(A2) License-based SSP Software
Three of the most well-known are:
1. Adobe FrameMaker, DESKTOP-based, launched in 1986
2. Madcap Flare: Both DESKTOP and CLOUD possible
3. Paligo: CLOUD-based Component CMS (CCMS
(A3) Adobe FrameMaker: Desktop - Structured (XML)/ Unstructured
Structured FrameMaker (the XML-based version) is particularly well suited for Single Source Publishing (SSP) because it is built to separate content (Source Topics) from presentation (Publications) and support reuse. The division into topics follows the DITA standard.
DITA stands for Darwin Information Typing Architecture and is an open standard (developed by OASIS) for structured, topic-based technical documentation.
Unstructured FrameMaker can still be used for technical documents, but lacks the built-in SSP logic with reuse and automatic multi-channel publishing.
(A4) Madcap Flare: XML - DESKTOP or CLOUD-based
MadCap Flare user its own XML-based content format instead of DITA.
The most important elements are:
Flare Topics (.htm) – each topic is a standalone XML/HTML file with metadata and embedded variables/conditions.
Snippets (.flsnp) – small reusable pieces of text that can be inserted into multiple topics.
Variables & Conditions – manages product variants, languages, and version differences.
Project File (.flprj) – keeps track of the entire project's structure, templates, skins and output goals.
Master Pages & Stylesheets (CSS) – separates layout/presentation from content.
MadCap Flare is available as desktop withsoftware, but also in a hybrid/cloud-version: “Flare Online”. MadCap Software+3MadCap Software+3MadCap Software+3
Classic Flare is desktop-based and used locally on the computer for authoring, publishing, etc. MadCap Software+1
Flare Online: Ccloud component/platform enables collaboration, versioning, hosting, etc. in the cloud.
MadCap Software+2MadCap Software+2
Flare + Flare Online offline capabilities with cloud functionalities: You can work both online and locally. MadCap Software+1
(A5) Paligo: CLOUD-based Component Content Management System (CCMS)
Paligo is primarily a cloud-based CCMS (see below). Paligo+2Paligo+2
Which means:
Your content is hosted and managed via the cloud, and users log in via web browser. Paligo+2TechWhirl+22.
It is designed for collaboration, versioning, workflow, etc. directly online. Paligo+2TechWhirl+2
(A6) Component Content Management System (CCMS)
This allows a finer division in topics (small components):
You can use the individual components repositories and version control.
Strong focus on single-sourcepublishing, versioning, translation.
(B) SSP approach – with e.g. All-In-One Documents and Illustrations
(B1) Microphone calibration system:
All-In-One Document: Brochure, Datasheet, Instructions
(B2) Page 1 is Datasheet/Brochure:
First page: Brochure - the other pages are Instructions
(B3) Process diagram - as seen during software installation
I'm going through the entire datasheet here. The illustration below is the only one that is NOT relevant for Single-Source Publishing (SSP):
Process diagram,: IInspired by software installation:, where you also go through four steps:
1. Welcome → 2. License → 3. Installation → 4. Completed
(B4) Two All-In-One Illustrations: With four "roles"
All-In-One-Illustration No. 1: serves as ":1. Parts list (except for cables), 2. Function (flow diagram), 3. Installation instructions, 4. Setup for control/test
(B5) Last step in the process
All-In-One Illustration No. 2 - completely parallel to the previous illustration
