Why Standards Are More Beneficial Than You Think
1. About intelligent information and omnichannel distribution
The ongoing digitization of all things content-related requires us to rethink how we deliver user information. Technical documentation with hundreds of pages within one document is no longer viable. Users need intelligent content or intelligent information instead of documentation:
It provides target-oriented information for all product lifecycle phases and various search and filter options. Intelligent information is modular, structured, semantically enriched, and applications can evaluate it for specific usage scenarios.
1.1 From multichannel to omnichannel distribution
Intelligent information is published and brought to the users on various channels: as PDF, on the internet, in social media, in mobile applications, via chat bot or voice assistants. Based on the idea of single-source publishing, one piece of content is transformed into different output formats and can be presented in different media.
And the development goes on: The borders between the content types begin to blur and disappear as content is mixed on online platforms. And our users have never really cared where a specific piece of information came from, as long as it helps them with their current question.
For example, users want to be able to retrieve more detailed information about an advertised feature (marketing material) from the technical documentation.
Figure 1 Example: Linking marketing content with technical documentation content (Adobe)
Users expect the information in the different channels to be consistent regarding technical properties and terminology. Tone of voice and level of detail, however, may vary depending on channel and user. Content must be provided tailored to the user journey. A typical user journey could be to evaluate and compare product features and assess the quality of the documentation before making the decision to buy a specific product. During the journey, content must be findable and discoverable.
Today, content is authored, edited, and published by multiple groups using different IT systems: typically by marketing, technical communication, product management, technical support, service, training, and sales. Each content group creates a different type of content. Keeping these different content types consistent and providing a smooth user journey is one of the biggest challenges in today’s content engineering. Another challenge is the harmonization of technical formats and interfaces that are used to transport content between IT systems without creating a copy-and-paste hell for the authors.
1.2 How to make content suitable for omnichannel distribution
So, how do we create content that is suitable for omnichannel distribution?
In short, we could say that At the same time, the modules need to bear all the information required to create context and to determine the purpose of the content. It’s like creating a jigsaw puzzle with pieces that have content on the front, hidden instructions for use on the back, and little tabs for connecting to other pieces.
Properties of omnichannel content
Omnichannel content must have the following properties:
- Granular, meaning fragments and topics instead of documents
- Reusable for different audiences, contexts, and purposes
- Enriched with metadata for creating context and determining the purpose
- Portable, technically suitable for different media
- High-quality, fulfilling the information needs of the users – correct, understandable, appropriate, and accurate
- Distinct, separation between content and structure definition, content and layout, content and metadata
The importance of the content model
For an assembled jigsaw puzzle to look nice, all pieces need to follow the same design patterns. Otherwise the assembled image would look scrappy. The design of content is shaped by its terminology and its structure. : instructions, procedures, feature descriptions, technical data, how-to videos, training units, exercises, and others.
Within the content, a consistent terminology helps readers to understand and grasp the information quickly. And even though terminology management has a long tradition in technical communication, a lot of organizations still have a long way to go to reach company-wide terminology management. How often have you seen a marketing brochure that speaks the same language as the user documentation?
The importance of harmonized metadata
Let’s go back to our jigsaw puzzle image. In order to assemble the pieces, the little tabs at the end of the pieces need to fit the corresponding blanks of other pieces. Also, we need the information on the backside of the pieces – who needs this information and when? Tabs, blanks, and backside notes are represented by metadata assigned to content modules. Metadata supports content selection based on queries and assembly of information into larger documents.
Figure 2 Connecting metadata for content modules. © Ulrike Parson
Just as terminology controls the language within the content, a harmonized vocabulary controls the language within the metadata. A corporate taxonomy is as important as terminology and content types. Otherwise, the search or filtering functions of the content delivery systems would have to consider all possible terms within metadata and relations between content modules. This would lower the quality of search results and make the assembled content less readable. By harmonizing metadata we connect related content across discovery, access, and management.
2. How do standards help us?
Harmonizing content types and metadata is difficult enough when you have to do in your own organization. To achieve this kind of harmonization across organizations, you need strong nerves. But as digitization progresses, content needs to be orchestrated not only within one company, but also across organizations and products. Consider a smart factory where machinery and devices from different manufactures are combined in common processes. It means that the information on how to operate and maintain this machine park needs to assembled and aggregated from different sources. This requires standardized delivery formats and taxonomies.
Figure 3 Intelligent information for smart factories. © Iconimage - Fotolia.com
This is where standards come into play.
Standards can refer both to technical solutions and methodologies. That means you can use a specific standard format or interface or a standard approach for developing your content model. Some standards are maintained by official standardization organizations such as DIN, ISO, IEEE, and OASIS. Others are de-facto standards originating from individual companies.
2.1 Benefits and disadvantages of standards
Standards offer various benefits:
- They are usually developed by subject-matter experts from leading industry companies and contain a lot of know-how and practical experiences. Most standards are updated on a regular basis to reflect the developments within the industry.
- Standards come with documentation.
- Companies use standards as reference to harmonize their purchasing processes.
- Standards define specific quality criteria so that compliance implies good quality.
- Especially standards from international standardization organizations, such as ISO, are agreed on within the industry.
There is a dark side, of course, because one size does not fit all. A standard needs to be generic to a certain degree, otherwise it won’t fit everyone. A standard represents a compromise between the individual interests of the contributors and stakeholders.
A good example of a compromise is the DITA standard. It contains different domains for specific purposes, such as the Programming domain or Learning domain. These domains reflect the interests of DITA users that need to write developer guides or training courses. Overtime, attempting to meet the needs of everyone expands the core elements to such an extreme that the standard may become bloated and unwieldy for many potential uses.
Working in a standardization committee and developing a standard for any purpose can be a tedious task, because compromising takes more time and effort than just following your company’s roadmap. This is the reason why industry standards tend to lag behind recent industry developments.
2.2 Existing standards for technical communication content
With regards to technical communication content, there is already a number of standards that we can use. Some of them are mere technical standards defining formats or interfaces, others also define semantics and content models.
||XML data model for authoring and publishing user information
|Widely used in the US, in Europe only in selected industries, e.g. semiconductors and software.
||Ontology for user information and package format for content delivery
||The iiRDS ontology is defined in RDF, a format of the semantic web.
||Technical standard for formulating logical statements about web resources. Standard for describing metadata
||Part of Semantic Web family of standards.
||Common data model for sharing and linking knowledge organization systems via the Web. Designed for the representation of controlled vocabulary.
|Part of Semantic Web family of standards.
||Collection of open standard vocabularies for different domains
When we go back to the requirements laid out in 1.2 “How to make content suitable for omnichannel distribution”, I think that from this list, the DITA and iiRDS standards are most relevant for technical communicators:
- DITA provides both a file format and a semantic content type definition that are well suited for authoring content modules. Both make sure that all the jigsaw puzzle pieces follow the same design patterns.
- iiRDS provides standardized metadata that can be used to enrich content modules with context and purpose information. This information shapes the tabs, blanks, and backside notes of our jigsaw puzzle pieces. In addition, the iiRDS package format allows content creators to deliver their content in a standardized way.
Both standards offer default specialization and customization mechanisms that enable companies to extend and adapt structures and vocabulary to their needs.
3. Challenges for Technical Communicators
Creating omnichannel content is a challenge that many companies face and most of them still have a long way ahead of them. Why? Because their content is still stuck in silos and proprietary formats. Because their systems do not exchange information or reuse content among each other. And because their processes are not laid out for content collaboration.
On the other hand, our industry is beginning to change. We can reduce effort and investments by using established standards as a basis for developing a harmonized content model for the organization. This also makes proprietary solutions leaner and easier to exchange.
Figure 4 Using industry standards as basis. © Ulrike Parson
To produce and distribute omnichannel content, organizations must adapt their content workflows, bridge their IT systems, and harmonize their content models.
There are crucial benefits when we use industry standards as the basis for these new workflows:
- We utilize the knowledge of the experts who contributed to the industry standards.
- We make workflows and IT systems less dependent on specific vendors and systems and more interchangeable.
- We enable content synchronization across organizations and products.
For technical communication content, there are a number of standards. DITA and iiRDS are an especially good match, because together they cover content and metadata model.
Organizations should invest in the development and maintenance of industry standards as part of their research and development activities to facilitate modern standards that provide a common ground for innovative content solutions.