The Proper Use
of Reuse in XML
Society of Technical Comminicators (STC)
Milwaukee Chapter, May 2016 meeting
May 25, 2016
John L. Hoh, Jr.
The Proper Use of Reuse in XML
•
•
•
•
What is XML?
eXtensible
Markup
Language
2
The Proper Use of Reuse in XML
Extensible Markup Language (XML) is a markup language that defines a set
of rules for encoding documents in a format that is both human-readable
and machine-readable. It is defined by the W3C's XML 1.0 Specification and
by several other related specifications, all of which are free open standards.
The design goals of XML emphasize simplicity, generality and usability
across the Internet. It is a textual data format with strong support via
Unicode for different human languages. Although the design of XML
focuses on documents, it is widely used for the representation of arbitrary
data structures such as those used in web services.
Several schema systems exist to aid in the definition of XML-based
languages, while many application programming interfaces (APIs) have
been developed to aid the processing of XML data.
Wickipedia
3
The Proper Use of Reuse in XML
XML stands for EXtensible Markup Language.
XML was designed to store and transport data.
XML was designed to be both human- and
machine-readable.
W3 Schools (http://www.w3schools.com/xml/)
4
The Proper Use of Reuse in XML
XML has a concept called…
REUSE!
But what is “reuse”? What do we “reuse”?
That’s what tonight is about.
5
The Proper Use of Reuse in XML
6
What do you think?
What is “reuse” in your mind?
7
Examples
Replace Logic Board
1. Turn off Unit
2. Remove Cover
3. Remove Power
Supply
4. Remove Logic
Board
Replace Pump Circuit
1. Turn off Unit
2. Remove Cover
3. Remove Power
Supply
4. Remove Pump
Circuit
8
Similarities
Replace Logic Board
1. Turn off Unit
2. Remove Cover
3. Remove Power
Supply
4. Remove Logic
Board
Replace Pump Circuit
1. Turn off Unit
2. Remove Cover
3. Remove Power
Supply
4. Remove Pump
Circuit
9
Mindset 1
DON’T think book!
THINK chunks of usable information
DON’T think reader!
THINK user!
10
Mindset 2
THINK document management!
1. Turn Unit OFF
2. Remove Cover
3. Remove Logic
Board
1. Turn Unit OFF
2. Remove Cover
3. Remove
Power Supply
Turn Unit OFF
Remove Logic
Board
Remove Power
Supply
1. Turn Unit OFF
2. Remove Cover
3. Remove Pump
Circuit
1. Turn Unit OFF
2. Remove Cover
3. Calibration
Remove Cover
Remove Pump
Circuit
Calibration
11
How a User Uses Information
12
How Our Example Above Would Look:
Contents List
Turn Off Unit
Remove Cover
Remove Power Supply
Remove Pump Circuit
Replace Pump Circuit
Replace Heater
Reattach Cover
Turn On Unit
13
User Goes to Subject
Turn Off Unit
Remove Cover
Remove Power Supply
Remove Pump Circuit
Replace Logic Board
Replace Heater
Reattach Cover
Turn On Unit
14
Requirements
Preliminary and Close
<preliminaryRqmts> and <closeRqmts> The
<preliminaryRqmts> and <closeRqmts> elements are required
for all procedural and fault isolation data modules. The
elements provide the actions to be done or conditions that
must be satisfied before and after a procedure is performed.
The <closeRqmts> element captures any actions that are
required after the procedure is complete to return the
equipment or system to a serviceable condition. The
<preliminaryRqmts> and <closeRqmts> elements both include
the child element <reqCondGroup>. The <preliminaryRqmts>
element also includes child elements: <reqPersons>,
<reqTechInfoGroup>, <reqSupportEquips>, <reqSupplies>,
<reqSpares>, and <reqSafety>.
15
Our Example Again
Remove Logic Board
Preliminary Requirements:
LOTO
Turn off Unit
Remove Cover
Remove Power Supply
Safety
All your safety for this component.
Remove
1. Step by step
2. Instructions
16
Example (continued)
Remove Logic Board
Replace
1. Step by step
2. Instructions
Close Requirements:
Reinstall Power Supply
Reinstall Cover
Turn on Unit
Remove LOTO
17
Reuse
• ONE data/content module for each task.
• May be a sentence or two.
• Reduces document maintenance. How often
would the task of removing the cover be
replicated?
• Ease for user—gets to the heart of the matter,
but has links in case there is doubt.
18
Why?
• Prominent use of iPads, tablets, iPhones,
smart phones, laptops to access service
information.
• Online quicker than .pdf.
• Generally .pdf or print may not be the most
recent.
• Easier to use and maintain.
WELSTech 2015 * John L. Hoh, Jr.
19
Questions?
20
Thank You!
¡Gracias!
21