This paper tells the story of Silicon Graphics IRIS InSight, the first system for viewing online documentation from a computer vendor that uses SGML, the Standard Generalized Markup Language (ISO 8879) [7]. SGML's explicit encoding of structure and its separation of structure and presentation make possible structure- based search, alternative structural views of the same information, dynamic reformatting, and alternative presentation styles. SGML enables Silicon Graphics to produce more consistent and complete documents while automating many otherwise tedious production tasks. Over time SGML will enable Silicon Graphics to reuse much more of the information it creates and better synchronize the development of documentation with the products it supports.
Since late 1992 the IRIS InSight viewer and the core IRIS InSight Document Library, which contains several technical manuals, have been bundled free with every Silicon Graphics computer. (IRIS InSight is a family of support tools that provide online access to product, support and technical information, and various services). This bundling makes online documentation pervasive and truly cost-effective. The ubiquity of the online documentation viewer and the openness of an SGML based-system allows developers of Silicon Graphics software applications or other Silicon Graphics customers to use IRIS InSight to deliver online documentation for their own applications. Usability tests with IRIS InSight demonstrate that a clear majority of first-time users prefer it to using hardcopy manuals.
We begin this paper with the user's perspective on IRIS InSight. While SGML is the basis of many of the viewer's functions, SGML is not directly visible to end users. SGML is visible and important to varying degrees to authors, production staff, management, and others involved in the overall IRIS InSight effort. We explain these different perspectives so that others can appreciate how the costs and benefits of SGML are allocated among different individuals and organizations in an overall SGML-based publishing process.
Since the IRIS InSight effort began in late 1990, we've seen an enormous increase in the visibility and viability of SGML. The growing success of SGML makes our decision to adopt SGML in IRIS InSight seem far more obvious and easy than it was at the time. We review the key decisions and turning points in the project's history to identify important lessons for others considering a similar project.
The first author has worked as a consultant to Silicon Graphics from the beginning of its online documentation effort and his company, Passage Systems, continues to support Silicon Graphics and its developers by providing training, document conversion services, and document management software for IRIS InSight and SGML-based publishing. The second author has managed the IRIS InSight project since its inception and for a time concurrently managed a technical writing group at Silicon Graphics.