Audience Profiling

You can use the audience attribute to make content reusable and to publish customized deliverables.

Use Cases

Consider profiling your content with the audience attribute in the following scenarios:

  • Your customers use the same product but have different features enabled. This way, each customer can get personalized documentation that covers only relevant features.
  • You want to provide content that applies to different roles in your product. For example, users with Administrator roles may need system configuration information, but users with Reviewer role do not.
  • You want to include internal-only content in the documentation set. You can hide internal content from customer-facing deliverables and include it in internal documents.
    Tip: You can use internal content in your documentation to provide test-related information for your quality assurance (QA) team or restricted information for your technicians.

Audience Profiling Example

You include or exclude profiled content by applying a DITAVAL during publication.
Remember: By default, all content is included in published deliverables, unless you have applied conditional profiling.
Figure 1. Internal Step Element.

This example shows an internal step element (3). The step is not a part of the customer-facing documentation.

DITA task with step profiled to internal audience
Figure 2. Internal Step Result Elements.

This example shows internal step result elements. This way, the profiled elements are a part of the internal documentation for the quality assurance team but are not visible in customer-facing documentation.

DITA Task containing steps profiled to userTesting audience
Figure 3. Internal Topic.

This example shows an internal reference topic. The “Reference A” topic appears in the internal documentation for the field engineers but does not appear in the customer-facing documentation.

Reference profiled to internal audience
Figure 4. DITAVAL for Customer-Facing Documentation.

This example shows a DITAVAL that excludes internal content in the customer-facing output.

DITAVAL excluding content with audience set to internal