(y)our wiki about all things technical communication

User Tools

Site Tools


Why use conditional processing

When you write documentation for a certain series of products, several products can share much information. For instance, the task describing how to install an appliance can largely be shared between different models or versions of that appliance. At the same time, each model might have its own unique requirements for the installation procedure.

Rather than having to rewrite the whole procedure for each model, you can include all information in one topic or map and apply conditional attributes to the model-specific information. When you later publish this information, you can use these attributes to either highlight relevant information per model or filter out unwanted information.

Concretely, conditional processing allows you to:

  • Create different output from a single topic by filtering out unnecessary information for each output type. This way you only have to maintain one core set of topics and automatically ensure that all generated versions of it contain the same up-to-date shared content.
  • Highlight specific content: for instance, information which is only relevant to a specific version of a program.
  • Improve how writers find specific content: writers can find topics in their content management systems by searching for information about the topics, such as feature numbers or product names.
dita/why_use_conditional_processing.txt · Last modified: 2017/03/30 13:16 (external edit)