Video for Online Help: DITA, HTML5, and Multimedia

The adoption rate of the Darwin Information Typing Architecture (DITA) has been truly remarkable. While its growth stems from and is most apparent across those organizations that publish technical documentation, DITA is certainly not limited to technical publication departments. Because of its specialization feature, DITA is now viewed by a variety of businesses as a stable, low-cost solution to all sorts of documentation from marketing to financial reports to training material and so on. By some estimates, over 80 percent of new XML publishing implementations are DITA-based.

For those interested in leveraging HTML5 media tags such as video, audio , and canvas within a DITA authoring context, you will find documentation and demo files of one approach on the Wild Basin Media site. The current version of the demo addresses HTML5 video, audio and canvas elements.

Also on the rise is the use of video deployed to the Web, which should be of no surprise to even the occasional Internet user. Anecdotal evidence of this ascendancy has to include YouTube, the fastest growing site in Internet history. Earlier this year, YouTube announced that it past the 3 billion views-a-day mark, a 50% increase over its 2010 stats. That is the equivalent of nearly half the world’s population watching a YouTube video each day, or every U.S. resident watching at least nine videos a day. One has to look no further than the homepage of the United States White House website to see how mainstream Web video has become and how much value has been put in its ability to communicate a message to a broad audience.

For years we have been hearing that HTML5 is only months away from being realized by the cyber brokers: Apple, Microsoft, Adobe, Google, Mozilla, et al. However, 2011 was really a watershed year for HTML5 as symbolized by Adobe’s announcement that it will be discontinuing development on mobile browser Flash in favor of HTML5. HTML5 is of particular interest to those in the video world because it allows video to be played by the browser without the need for 3rd-party players or home-grown implementations. While the asterisks to the use of the HTML5 video element are many, the cyber brokers realize that delaying implementation of the HTML5 specifications will result in their competitors gaining a market advantage. In short, critical mass has been reached.

So why haven’t we seen more video integrations with online documentation such as DITA? At face value, video would seem to be a perfect fit with task-based procedural documentation because of its ability to show how to do a task or series of tasks.

The lack of such implementations is due in part because video is largely a black box. The information within it is rarely described with the necessary level of precision. Most viewers will not watch 10 minutes of video to find 30 seconds of relevant material. Many how-to video services provide users with search capabilities; however, the level of granularity for these videos is usually too high to be applied to technical, task-based documentation where the ability to quickly find and understand discrete steps is key. Video chunked into relatively large pieces by typical methods is as unwieldy as coarsely-chunked unstructured documentation. Content reuse and searchability become at best difficult or at worse impossible.

What if steps within a DITA-based topic had video links to show how to complete a discrete step or procedure? We have all used search engines that allow us to enter criteria that return topics where the text is found. What if we entered search terms that take us to a particular video segment that demonstrates how to complete a specific task? What if we could browse clickable thumbnails to find relevant video segments? What if every time a video segment displays, its associated text-based topic displays as well?

Playlists are an important component in the advancement of video-integrated documentation, and provides of bridge to these solutions. XML playlists such as XML Shareable Playlist Format (XSPF) adhere to content description standards. Its tagged data can be passed into, or accessed by, devices or computer code. This description standard is not aimed at any one application in particular; rather, it supports a range of applications. XSPF uses XML to store metadata that references multimedia resources. It provides fast and efficient searching, filtering, and content identification when coupled with XSLT or XQuery.

Playlist tracks can be associated with video time-code segments in order to tag particular events within video such as particular steps within a “how-to” procedure. These video segments are then retrieved and viewed through the corresponding metadata. Video components described by playlist tracks can be integrated into online documentation and made accessible to users in a similar way as are, for example, text-based components in DITA. From an author’s perspective, adding video to a documentation set is as easy as inserting a resource id into the XML source—just like one would for an image. Like their text-based counterparts, video components may be reused across topics and documentation sets. XML playlists offer a standardized approach to the management of video metadata.

For the greatest user experience possible, video production must adhere to quality standards and best practices. For example, even though video segments may be remixed across multiple documents, captured by multiple video teams over time, and processed by more than one editor, for users video segments should all appear as if they have originated at the same time and in the same place (see consistency). Publication departments deal with disparate writing styles among their writing staff by using a style guide. Similarly, the medium of technical video requires its own style and best practices guides to govern lighting, shot angles, sound quality, video formats, common workflow processes, etc. Like text-based content and images, video segments are subject to revisions and updates. Fortunately, XML playlists also provide a systematic way of dealing with video revisions, too.

To be sure, there are special considerations when using video in online documentation, but imagine the benefits of having a methodical way of viewing discrete steps within, for example, an airplane engine maintenance manual. Mechanics could search across playlist repositories to find and view appropriate video segments and read the associated DITA-based documentation adjacent it for further reference. Because many parts and procedures are identical across plane models, standard reuse and effectivity principles can be employed for video in the same way as for text-based content. Just as task-based documentation is modularized so that new documents can be created from pieces of existing text, video segments, each assigned a unique id, can be reordered into new configurations. In short, the same themes (e.g., reuse, modularization, metadata employed for increased searchability, reduction of information redundancy) that run through the design of structured documentation can be applied to video with the help of XML playlists and associated technologies.

To this point, I’ve only mentioned camera-generated video as it applies to online documentation. However, software-generated video (i.e., screen capture software such as Camtasia, Jing, Captivate, and IShowU) can be segmented, managed, and deployed in the same way. For example, it is possible to re-purpose your existing walk-through video of your latest software product so that video segments can be searched and viewed. Because each segment is allocated a unique id and associated with metadata, segments can be reordered and reused where appropriate. This type of video is not equipment or software intensive. In fact, you may already have almost everything you need already.

With new video standards and practices, it is now possible to merge video seamlessly into online documentation for the Web with greater control over its management, search and presentation. The convergence of greater bandwidth speeds, major browsers conforming to HTML5, and cost-cuts in video production workflows make video-integrated documentation a viable enhancement to your documentation. It is conceivable that in the near future, video will be an integral part of online documentation, just as it has in the Web at large.