25. Provides information about one specific aspect of a subject area, such as what it is, how
it’s diagnosed, treatment options, etc.
Comes in three sizes: main point, summary, and full detail. May not need all three sizes
because sometimes info can’t be boiled down to a main point or summary, and
sometimes there’s not enough info to warrant a full detail.
26. How-to info—steps that need to be done in a specific (i.e., numbered) order.
• Each step should be its own bullet. Supporting info for a step goes into separate tags.
• Length: No length limits, but the step names (commands) should be short, and the
supporting info should be between 1 and 3 sentences.
33. HealthwiseTopicTypes
Topic Type Description
InfoConcept Informational, Educational; Available in 3 sizes
Task Instructional, How-to
Action Actionable, non-sequential
When to call When to call 911 or your doctor
Story Personal stories
Media Images with titles, captions, alt-text
Video Videos with titles and captions
Definition Healthwise definitions
Library topic DITA reuse mechanism
Slideshow Healthwise slideshows
Message For user contact in campaigns
Decision component Information targeted at a medical decision to be
made
Decision assessment Interaction to gather and record a response to a
prompt
34. HealthwiseTopic Sub-Types
Topic Type or Tag Attribute and Value
Message Type = Boilerplate
Message Type = Call to action
Message Type = Teaser
Decision assessments
Quiz question Opinion
Quiz question Fact
Quiz question Scale
<p> Lead-in
<li> Icon type
40. CONREF
Type: Stem Topic
Aspect:
Concept: Pinkeye
(Parent topic for a
document output.)
Type: InfoconceptSU
Aspect: careInstructions
Concept: Pinkeye
-Burst from legacy PI
-BP language conreffed
from library topic.
41. CONREF
CONREF
Type: InfoconceptSU
Aspect: selfCare
Concept: Pinkeye
-Burst from legacy PI
into library topic;
conreffed into this topic
Type: WTC
Aspect: When to call
Concept: Pinkeye
- Burst from legacy PI
into library topic;
conreffed into this topic
42. Type: Stem Topic
Aspect: afterVisit
Concept: Pinkeye
Type: InfoconceptSU
Aspect: careInstructions
Concept: Pinkeye
Type: InfoconceptSU
Aspect: selfCare
Concept: Pinkeye
Type: WTC
Aspect: WhenToCall
Concept: Pinkeye
MAP
Metadata
Aspect/Concept:
HWID:
??
Type: Stem Topic
Aspect: afterVisit
Concept: Pinkeye
Type: InfoconceptSU
Aspect: careInstructions
Concept: Pinkeye
Type: InfoconceptSU
Aspect: selfCare
Concept: Pinkeye
Type: WTC
Aspect: WhenToCall
Concept: Pinkeye
Footer? Logo? GtW?
T
o
p
i
c
r
e
f
s
Modeling
composition
43. Type: Stem Topic
Aspect: afterVisit
Concept: Pinkeye
Type: InfoconceptSU
Aspect: careInstructions
Concept: Pinkeye
Type: InfoconceptSU
Aspect: selfCare
Concept: Pinkeye
Type: WTC
Aspect: WhenToCall
Concept: Pinkeye
PI MAP
Metadata
Aspect/Concept:
HWID:
??
Type: Stem Topic
Aspect: afterVisit
Concept: Pinkeye
Type: InfoconceptSU
Aspect: careInstructions
Concept: Pinkeye
Type: InfoconceptSU
Aspect: selfCare
Concept: Pinkeye
Type: WTC
Aspect: WhenToCall
Concept: Pinkeye
Footer? Logo? GtW?
T
o
p
i
c
r
e
f
s
Library Topic
Self-care treatment info
• Item
• Item
• &c.
Library Topic
When to Call info
• Item
• Item
• &c.
C
O
N
R
E
F
Modeling reuse
46. Semantic markup is the use of a markup language such as
HTML to convey information about the meaning of each
each element in a document through proper selection of
markup elements, and to maintain complete separation
between the markup and the visual presentation of the
elements contained in the document.
Semantic markup
50. <hwActionTask>
<title>How to use a pedometer, step counter, or fitness app</title>
<hwActionTaskBody>
<context>
<p>Using a pedometer, a step counter, or a fitness app on your phone is an easy and fun way to track
how active you are. It adds up all the steps you take during the day. It can help motivate you to walk. A
quick check may show that you need more steps for the day and help you set goals to take more steps.
Some also can show you how many calories you've burned. Many of these apps are free.</p>
<p>Follow these steps to get the best use out of your device.</p>
</context>
<steps>
<step>
<cmd>Make using your step counter a habit.</cmd>
<info><p>Put it on or activate it first thing in the morning as you get dressed. Leave it on until you go
to bed.
</p>
</info>
</step>
<step>
<cmd>Find your activity level.</cmd>
<substeps>
<substep>
<cmd> Go about your usual routine for the first week. Don't change how active you are yet.</cmd>
</substep>
…
52. Topic types—Overview
1. Infoconcept
Example and guide
Provides information about one specific aspect of a subject area, such as what it is, how
it’s diagnosed, treatment options, etc.
Comes in three sizes: main point, summary, and full detail. May not need all three sizes
because sometimes info can’t be boiled down to a main point or summary, and
sometimes there’s not enough info to warrant a full detail. Consult with your editor as
needed.
Title (for all infoconcept sizes)
Usually a standard question (see the standardized titles section for the list of
standard titles).
Examples: What is angina? How is heart failure diagnosed?
Why is an MRI used?
70. Model Accessibility
• Build it into your content model
• Create accessible components
• Lowers testing and rework burden
• Assures designing to accessibility which is just the right and
smart thing to do
78. Voice and tone
• All artifacts are useful for both writers and designers
• Trying to communicate and accomplish the same
thing
• Let one connect to the other
Beyond the objects
79. Healthwise is… Like this: Not like this:
Authoritative, but not
authoritarian
Back surgery is
appropriate in some cases,
but it’s a good idea to
consider other options
before deciding.
Don’t have back surgery. It
always creates more
problems than it solves.
And you don’t need it.
Helpful, but not pushy Did you know that, if you
are a smoker, your back
injury will take longer to
heal? Quitting smoking can
help you feel better faster.
If you have a back injury,
quit smoking. Change your
habits, your friends, and
life, so you can get back to
normal.
81. Making your place
•Own the idea and the message
•Face up to the soft skills
•Help other people get their stuff
done better
•Go above and beyond so they will
too
82. See it through
• FINISHED finished
• Do your documentation
• Handoffable
• Loose ends can undo lots
• Keep the dots connected
So when we’re thinking about design, about how our content looks and behaves once it hits the webpage or app or whatever, it’s critical that all of the meaning and intent of your content is understood and enabled.
Maybe the problem is that those designers are just mean. Or lazy, or they don’t care about content… But probably not.
https://images5.alphacoders.com/295/thumb-1920-295965.jpg