Intelligent Product Manuals
Intelligent Product Manuals
net/publication/239406045
Article in Proceedings of the Institution of Mechanical Engineers Part I Journal of Systems and Control Engineering · May 2000
DOI: 10.1243/0954405001518198
CITATIONS READS
33 431
3 authors, including:
All content following this page was uploaded by Stefan Dimov on 18 November 2014.
Abstract: Intelligent product manuals are designed to allow product users to utilize a product as easily,
eectively and with as little additional care as possible while minimizing support costs for
manufacturers and suppliers. It is ®rst shown how intelligent product manuals address these
objectives by utilizing electronic, multimedia and knowledge-based technologies to provide active
assistance to the user of the product during tasks such as installation, operation and maintenance.
An architecture for the creation and deployment of an intelligent product manual is then proposed
and general design considerations are outlined. Finally, four implementation approaches, based on
XML, SGML, HTML and PDF technologies, are compared against a set of selection criteria. It is
concluded that simple, low-cost solutions are available, which can provide signi®cant bene®ts for
appropriate businesses, including smaller companies.
2.2 Conventional product support easy to use and maintain by virtue of this enhanced
task support. The bene®ts of this type of system are a
A product support network provides for the production reduced need for training and for skilled persons
or acquisition, storage and supply of the above support (decreased cost), and better and quicker task perfor-
items. It can include product training, technical docu- mance (reduced cost and improved performance).
mentation, help lines, servicing, spare part ordering Enhanced electronic communication between the
and maintenance management. Conventionally, all hardware, information systems and persons involved in
support items are brought together physically with the product support creates other opportunities to be con-
product, although information and persons can also be sidered alongside IPMs. These include computer-based
supplied remotely, e.g. by telephone link. training, remote hardware monitoring (e.g. via the Inter-
Despite this provision, product support can still be net), tele-presence of skilled persons (e.g. by video links)
costly, labour intensive and of poor quality, both from and integrated spare part ordering and maintenance
the supplier's and user's point of view. Supplies and management systems [1].
equipment considerations apart, these problems can be
linked to the various persons and information systems
involved in the support chain. High support costs are 3 ADVANTAGES OF INTELLIGENT PRODUCT
due to the necessary training of users and support sta, MANUALS
the transport of these persons where required, and the
time taken for them to access and understand relevant An IPM is a kind of technical manual [2]. The types of
task information. Poor support quality is due to a lack information contained in a technical manual are action
of adequately skilled or motivated persons and to information, support information and planning informa-
diculty in accessing and understanding relevant task tion, as shown in Table 1. The function of a technical
information. manual is to allow the user to access the pieces of infor-
mation that are being looked for and then to understand
2.3 Enhanced product support them so as to be able to perform the required task. Con-
ventionally, information access is achieved through the
IPMs are designed to supply to the user of a product search and navigation facilities listed in Table 2(a),
information of such high quality that the task of the while understanding is achieved by the presentation
user is eectively de-skilled. Thus the product becomes means, also listed in Table 2(a).
Item Description
Proc Instn Mech Engrs Vol 214 Part B SC01499 # IMechE 2000
INTELLIGENT PRODUCT MANUALS 413
Access (active) (according to user request) Presentation (dynamic) (in appropriate form)
Electronic
Search Text, tables and graphics
Freetext/index search Multiple windows/frames
Multiple document search Graphical zoom
Active tables of contents
Navigation
Hyperlink cross-references
Graphic hotspots
Navigation history
The goal of an IPM is to enable persons to undertake user understanding. Dierent forms of user interaction
tasks in connection with the product as easily, quickly such as touch screens, gaze control and speech recogni-
and accurately as possible and with as little skill or train- tion can also be used to advantage.
ing as possible. Similar concepts underlie the technolo- A knowledge-based manual allows complex decision
gies of interactive electronic technical manuals [3] and procedures, which in a paper manual would have to be
electronic performance support systems [4]. The overall shown in full, to be accessed in simple dialogue form.
function of an IPM is to guide a person in undertaking In this case, only information relevant to the current
tasks in connection with the product by providing infor- state of the decision process is presented to the user.
mation in a form and at a time most appropriate to the A very common and eective application is trouble-
user's needs and requests. The user-oriented function shooting. Another knowledge-based feature is user
of an IPM is to facilitate and expedite access to, and adaptation. Hard adaptation provides alternative views
understanding of, the required information, including of a manual, in terms of the level of detail shown or
the adaptive and predictive presentation of information form of presentation employed, according to the type
to the user. of user currently using the system. The user's skill or
The technologies employed in an IPM may be categor- experience and task or activity may also be taken into
ized as electronic, multimedia and knowledge-based. account. Soft adaptation additionally utilizes informa-
These augment the conventional provision for informa- tion about how the user is or has been using the
tion access and presentation as indicated in Table 2(b) system. The system may also be predictive by pre-
and as shown in Fig. 1. An electronic manual by itself emptively supplying information that is likely to be
oers great advantages over a paper manual in terms useful to the user. A ®nal relevant technology is intelli-
of active information access and dynamic information gent search with its in-built natural language processing
presentation. It also enables linking to, or integration facilities.
with, other IT systems, such as those listed under `data The potential combined bene®t of these technologies is
sources' in Table 1, as well as oering improved very signi®cant. However, these bene®ts are not achieved
manual distribution and maintenance. automatically. An electronic manual can easily be less
A multimedia manual allows dynamic audio-visual eective than its paper counterpart, which boasts high
presentation of information, e.g. videos or animations visual resolution and contrast, is often portable and
of maintenance procedures. These can greatly enhance requires no costly electronic hardware [5].
SC01499 # IMechE 2000 Proc Instn Mech Engrs Vol 214 Part B
414 D T PHAM, S S DIMOV AND B J PEAT
INFORMATION ACCESS
Navigation history Active contents Hyperlinks Freetext search Graphic hotspots
Item Considerations
Software Nature of existing documentation (focus, size, cost, complexity, longevity, update frequency)
Data already available and their form
Electronic and paper manual production (ideally) from a single source
Reliance on external consultants and sta training requirements
Delivery and development software meeting the above needs in a cost eective manner
is then to devise a credible and cost eective means of presentation, and with regard to integration within the
authoring and maintaining the necessary content, hyper- manual.
links, coordination of information within windows/
frames and integration of external data. These tasks
would preferably be as automated as possible and may 4.2 IPM life-cycle components
imply the use of structured authoring regimes. Multi-
media objects are relatively easy to embed in a manual. A generic IPM life-cycle architecture is shown in Fig. 2.
Knowledge-based facilities require more thought with This indicates the main data and data processing stages,
respect to knowledge representation, authoring and which are elaborated in Table 4. The critical components
DEPLOYMENT
VIEWING
DISTRIBUTION
Presentation PUBLISHING
PRIMARY DATA
Content
Structure AUTHORING Linking
Logic
PRE-CREATION
EXTERNAL DATA
SC01499 # IMechE 2000 Proc Instn Mech Engrs Vol 214 Part B
416 D T PHAM, S S DIMOV AND B J PEAT
Viewing system Physical interface Desktop, laptop, palmtop, headset, built-in display
Logical interface Document based, kiosk type, graphical (e.g. virtual reality based)
Software Adobe Acrobat viewer, World Wide Web browser, SGML browser (presentation)
Distribution system On-line (network) Local area network, wide area network, Internet (considerations include bandwidth, access
speed and reliability)
O-line (local copy) CD, electronic transmission
Electronic manual Format PDF, HTML, SGML, XML, Windows/HTML Help
Publishing system Description Document building and module collation
Paper document composition (presentation)
Linking within and between documents/modules (linking)
Primary data Format Microsoft Word, HTML, SGML, XML, Adobe FrameMaker
Authoring system Software Microsoft Word, HTML editor, SGML editor, XML editor, Adobe FrameMaker
Description Document/module level authoring (content, structure).
Cross-references and other links, including links to external data (linking)
Program development (logic)
External data Examples CAD software, parts database, management information system, multimedia software
Management system* Description Management of data and data links within the above software components by means of product
data management systems, document management systems or management features built into
other software
Not included in Fig. 2
to be selected for an IPM are the viewing system and the structure and presentation features. An Adobe PDF
authoring/publishing systems. Also shown in Fig. 2 and (portable document format) ®le may be created as a
in Table 4 are the ®ve document attributes that are simple electronic copy of the `paper' document with
applied at dierent stages during IPM creation and structure and presentation features embedded in the ®le
deployment. These attributes are structure, content, in a proprietary format.
presentation, linking and logic. (Hyper-)linking can take place both at the content
The separation of structure, content and presentation authoring stage and at the publishing stage, where a
is most clearly seen in systems based on SGML (Stan- modular document paradigm is employed. Again,
dard Generalized Markup Language) [6]. In this case a SGML/XML provides a ¯exible open solution, which
structure document or DTD (document type de®nition) allows a separate linking document or `layer', HTML
precedes authoring, specifying what document elements provides a ®xed open solution and PDF an embedded
are permissible and in what order they may appear. Like- proprietary solution. Logic is particularly relevant to
wise, separate presentation documents or stylesheets, conditional information and leads to programs rather
based on the DTD, precede paper publishing or electro- than simple documents. Programs are natively supported
nic display. The devising of structure and presentation under HTML/XML using the Java virtual machine built
documents represents set-up or preparatory phases into Web browsers.
before document instances can be authored or deployed.
HTML (HyperText Markup Language) is an SGML
application, designed to work on the World Wide Web 4.3 Four implementation approaches
(or simply Web). It has ®xed structure and presentation
forms that are eectively embedded in the authoring Table 5 compares four implementation approaches for
and viewing software respectively. This provides a pre- IPM creation and deployment. These are word-processor
prepared environment for authoring and viewing electro- authoring and PDF viewing, HTML authoring and
nic documents. XML (eXtensible Markup Language) [7] viewing, SGML authoring and viewing, and XML
is an SGML pro®le (a simpli®ed SGML), allowing most authoring and viewing. Other combinations of these
of the features of SGML, such as separation of structure, authoring and viewing environments are also possible.
content and presentation, but designed speci®cally to An example of an IPM implementation using SGML is
work on the Web. shown in Fig. 1. The four approaches are assessed (the
Document authoring in a word-processing environ- more black dots the better) with respect to delivery
ment, such as Microsoft Word, typically allows structure software capability and, in part, ease of development.
and paper presentation features to be embedded into the There is an emphasis on lower cost systems (viewers
document as the document content is entered. Document <£100, authoring systems <£1000) suitable for smaller
templates, however, do provide some separation of businesses. It should be noted, however, that the
Proc Instn Mech Engrs Vol 214 Part B SC01499 # IMechE 2000
INTELLIGENT PRODUCT MANUALS 417
AccessÐsearch {
Freetext search C
Multiple document search C
Intelligent search C
Index search S Keywords Elements/attributes
Active table of contents S Bookmarks (Fixed DTD) (External DTDs)
AccessÐnavigation
Hyperlinks Li Embedded HTML links SGML links** XML links, XLink
Graphic hotspots Li Embedded HTML links SGML links XML links, XLink
Navigation history
Presentation
Text, tables, graphics P Fixed page copy Fixed `stylesheet' External stylesheets XSL stylesheets
Multiple windows/frames
Graphical zoom
Multimedia
Knowledge-based
Decision support Lo Java, ECMAScript Hyperlinks Java, ECMAScript, XSL
Adaptation (hard) Lo Multiple stylesheets Multiple stylesheets
Adaptation (soft) Lo Java Java
Prediction Lo Java Java
Miscellaneous
Ease of use Complex development
Robustness
Non-proprietary
Cross-platform viewing
Con®gurability
Integration (databases, software)
Paper output (including table of
contents)
technology involved, and software support for particular links can be established with server databases. A
features, is changing very rapidly, particularly with disadvantage is that generated HTML, itself a changing
respect to the HTML/XML and the Web. More func- standard, is often not validated. Also, formatting tends
tionality is provided by more expensive software within to be limited and browser-dependent or else embedded
the SGML environment and by additional utilities or in the document, though the adoption of (cascading)
software within the PDF and particularly the HTML/ stylesheets may improve this situation. There is no auto-
XML environments. matic means of generating an active table of contents and
The PDF solution is a simple, low-cost option utilizing full printing facilities require separate composition soft-
Adobe Acrobat software with free viewers available for ware, although the free program HTMLDOC [8] is one
most platforms. No re-formatting is required, but the means of providing these latter items.
®xed sized pages may not be suitable for on-line viewing. The SGML solution, with its inherent document
In general, manual post-processing is required to validation and open DTDs, is a robust and ultimately
produce `active' tables of contents, hyperlinks, and ¯exible solution. However, it has signi®cant set-up
links to external ®les, e.g. video clips. However, the costs, in terms of the number, cost and complexity of
Adobe Acrobat 3 software plug-in PDFMaker provides required components. A full SGML system can auto-
automatic creation from Microsoft Word 97 of these matically produce electronic and paper copy for every
items, while similar features are now available natively document conforming to the chosen DTD. Even a
in Adobe Acrobat 4. cheap SGML viewer, such as SoftQuad Panorama Pro
The HTML solution is also cheap to implement and (Fig. 1)* can provide con®gurable automatic generation
enables easy authoring, viewing and Web delivery for of multiple tables of contents and multiple views of
simply constructed electronic documents. Programs can
easily be incorporated within documents and real-time
This product has now been taken over by Interleaf.
SC01499 # IMechE 2000 Proc Instn Mech Engrs Vol 214 Part B
418 D T PHAM, S S DIMOV AND B J PEAT
documents via stylesheets. The DocBook DTD [9] is a an XML application for this purpose, together with suit-
commonly used DTD for technical documentation, able authoring tools, would also be valuable [16].
although the range of elements available may necessitate
training or system tailoring for eective use.
A more costly, strictly modular SGML approach is 5 CONCLUSIONS
employed by the aerospace and defence industries. In
this case, each document module contains control The role that IPMs can play in reducing product support
information to enable easy database management of costs through the use of electronic, multimedia and
large quantities of documentation and the subsequent knowledge-based technologies has been outlined.
production of virtual documents. This also allows Simple, low-cost systems are available to produce IPMs
standardized integration with logistic support analysis that can provide signi®cant bene®ts in terms of informa-
and materials management systems, and ideally with tion access, task understanding and decision support.
the design environment where document modules can More complex IPM systems traditionally have rela-
be associated with design components. Module coding tively high set-up costs that are perhaps not aordable
requires some initial eort. However, module DTDs by smaller businesses. However, this is now changing
tend to be very restrictive, making authoring compara- with the take-up of SGML-like features on the Web in
tively easy. the form of XML.
The XML solution provides many of the bene®ts of
SGML while operating in the interactive and tool-rich
Web environment. The ability of the latest Web browsers ACKNOWLEDGEMENTS
natively to view XML documents is a signi®cant advan-
tage for distribution. The open nature of XML and its This work was supported by the Welsh Oce and the
modest parsing requirements are an encouragement for European Commission through the ERDF and INCO-
XML tool development. Furthermore, XML is now COPERNICUS programmes (reference numbers EU
employed as a data exchange format, as well as a docu- 13802004 and INCO-CP96-0231). The prototype intelli-
ment format, so that product data, e.g. converted on gent product manual shown in Fig. 1 utilizes information
output to XML, can be more easily integrated with pro- supplied by Sparky Company, Rousse, Bulgaria.
duct documentation [10, 11]. Work is also underway to
provide XML-native data modelling schemas, for
which DTDs are not adequate. Other relevant XML REFERENCES
applications include proposals for manufacturing and
business process modelling [12, 13], for multimedia 1 Harmison, M. Creating electronic documents that interact
content description and presentation [14], and for indus- with diagnostic software for on-site service. IEEE Trans.
try-speci®c applications, such as electronic component on Prof. Commun., 1997, 40(2), 92±101.
information exchange [15]. 2 BS 4884: 1993 Technical Manuals, Part 2: Guide to Content,
For HTML and XML, server-side scripting, browser 1993 (British Standards Institution, London).
plug-ins and browser-supported scripting may addition- 3 US Department of Defense Military Speci®cation MIL-
ally be employed. These may be used, for example, to PRF-87268: Manual, Interactive Electronic Technical;
General Content, Style, Format, and User Interaction
provide an active table of contents or a graphics zoom
Requirements, 1992.
facility. The XML styling language, XSL, however, pro-
4 Fischer, O. and Horn, R. (Eds) Electronic performance
mises a `non-programming' way of addressing some of support systems. Commun. ACM, 1997, 40(7), 31±63.
these document `behaviour' issues. The XSL formatting 5 Jenkins, S. No plugs, no wires, no rivals. The Times News-
language proposes a common standard for electronic paper, London, 14 January 1997.
and paper output, including, for the electronic version, 6 ISO 8879: 1986 Information ProcessingÐText and Oce
the layout of frames. The companion XSL transforma- SystemsÐStandard Generalized Markup Language
tion language is at a more advanced stage of develop- (SGML), 1986 (International Organization for Standardi-
ment. This allows server- or client-side transformation zation, Geneva).
of XML from one DTD to another, or to other text- 7 World Wide Web Consortium, Extensible Markup Lan-
based formats such as HTML. Finally, it may be noted guage (XML) 1.0, W3C Recommendation, February 1998
(www.w3c.org).
that SGML-to-XML conversion, where required,
8 Sweet, M. R. HTMLDOC 1.7 User's Guide, 1999.
should be relatively straightforward, due to the close
9 Organization for the Advancement of Structured Informa-
correspondence between the two languages. tion Standards (OASIS), DocBook 3.1 DTD, February
The developing XML linking language, XLink, may 1999 (www.oasis-open.org).
be suitable for the linking within a product manual. 10 Burkett, W. C. PDML Product Data Markup Language: a
Some logic- or knowledge-based aspects of a product new paradigm for product data exchange and integration.
manual, e.g. fault diagnosis trees, can be directly repre- White Paper, Product Data Integration Technologies Inc.,
sented in XML and acted upon using XSL. However, Long Beach, California, April 1999 (www.pdit.com).
Proc Instn Mech Engrs Vol 214 Part B SC01499 # IMechE 2000
INTELLIGENT PRODUCT MANUALS 419
11 ISO/WD 10303-28 Product Data Representation and 14 Ram, A., Catrambone, R., Guzdial, M. J., Kehoe, C. M.,
Exchange: Implementation Methods: XML Representation McCrickard, D. S. and Stasko, J. T. PML: adding ¯exibil-
of EXPRESS-Driven Data, October 1999 (International ity to multimedia presentations. IEEE Multimedia, 1999,
Organization for Standardization, Geneva). 6(2), 40±52 (see also www.oasis-open.org).
12 Representing PSL as XML. National Institute of Standards 15 Electronic Component Information eXchange (ECIX)
and Technology, Gaithersburg, Maryland, September 1999 Project Overview, Silicon Integration Initiative, 1999
(www.nist.gov). (www.si2.org).
13 XML based process management standard launched by 16 Arti®cial Intelligence Exchange and Service Tie to All Test
Work¯ow Management CoalitionÐ`Wf-XML'. Work¯ow Environments, IEEE Standards AI-ESTATE SCC20
Management Coalition, Winchester, July 1999 (P1232) (The Institute of Electrical and Electronics Engi-
(www.wfmc.org). neers, New York) (www.ieee.org).
SC01499 # IMechE 2000 Proc Instn Mech Engrs Vol 214 Part B