tc dojo presentation writing mobile documentation
DESCRIPTION
Discusses whether content to be viewed on mobile devices has to be cut, rewritten, or both in order to be most useful. My March 3, 2014 presentation for TC Dojo.TRANSCRIPT
![Page 1: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/1.jpg)
Writing for MobileRewrite? Cut?
![Page 2: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/2.jpg)
Who Am I?
Neil Perlin - Hyper/Word Services.– Internationally recognized content creation and
delivery consultant.– Help clients create effective, efficient, flexible
content in anything from print to mobile.– Writing for online since 1986.– Working with mobile since Windows CE and
WML/WAP c. 1998– Certified – Viziapps, Flare, Mimic, RoboHelp.
![Page 3: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/3.jpg)
The Issues
How should we write for mobile?– Rewrite our existing material?– Cut our existing material?
Question goes beyond “writing” alone due to technical side of today’s tech comm.– A more complex version of the “no dumping”
theme of the early ‘90s. Must first define “mobile” in your context.
![Page 4: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/4.jpg)
What is “Mobile”?
![Page 5: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/5.jpg)
What is “Mobile”?
“Mobile” is essentially = the “undesktop”
» Images from 99designs.com, biblog.arcplan.com
![Page 6: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/6.jpg)
What Type of Mobile?
If apps, they’re usually function-centric.
Differ from “normal” tech comm…
![Page 7: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/7.jpg)
What Type of Mobile?
But some apps are content-centric, effectively tech comm.– With a lot of text in this case.
![Page 8: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/8.jpg)
What Type of Mobile?
What about this?
![Page 9: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/9.jpg)
So Can We Write for Mobile?
Yes, depending on what mobile we mean.– A laptop is a PC.– A tablet is a small laptop without a keyboard,
can show PC-type content in browser windows.– A smartphone is completely different.
And depending on whether we’re talking about:– Web apps – browser-based.– Native/hybrid apps – platform-based or both.
![Page 10: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/10.jpg)
A Design Fix For the Undesktop
Responsive design – display-agnosticism. For example, from RoboHelp 11.
![Page 11: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/11.jpg)
But Consider…
Cross-device/format/authoring tool issues:– Images may be too wide for phone screens.
» Can size them relatively to fit available screen.» But are they still legible?» If not, can you conditionalize them out?» If you do, does that affect the content?» May call for greater granularity of content…» And need a CMS to deal with the greater # of
content chunks even if traditional help did not.
– Ditto tables.
![Page 12: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/12.jpg)
More…
– Consider SWFs.» Won’t run on iOS – must be MP4 or HTML5.» Are text captions legible or must you replace them
with audio = creating 2+ versions of each movie.» What happens to interactivity with no mouse?
– Minimal table support in ebook formats.– “Invisible” problems of content in snippets.– And more…
![Page 13: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/13.jpg)
Dealing With Text-Heaviness
Cut down text – not fat but real text – to the bare bones, such as:– If 1, land.– If 2, sea.– Ride.– Spread alarm.
» With apologies to Henry Wadsworth Longfellow and The Midnight Ride of Paul Revere.
![Page 14: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/14.jpg)
Dealing With Text-Heaviness
Have you reviewed your content lately for legacy content?– Mechanical, like how to use a mouse?– Domain knowledge, like accounting principles
in accounting software?– Stuff that’s just no longer applicable?
Can you delete content that may not apply to mobile but that may still be necessary?
If so, where do you put it? For example…
![Page 15: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/15.jpg)
The Battle of the Sunda Straits
Created a multimedia project in ‘93 about a little-known naval battle from 1942.– Had 15 frames describing the action, with ~30
paragraphs of text.– Boiled down from 75 pages in Morrison’s
History of US Naval Operations in WW2.– No web in ‘93, so the cut 70+ pages were lost.– Can your cut material be made available if
users need it?
![Page 16: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/16.jpg)
Summary – Rewrite or Cut?
Both.– Cut to shorten the content and to account for
technical limitations or requirements.» But make the content available if still important.
– Rewrite the remainder to account for the cuts and to improve the writing in general.
We still want good writing, just less of it and more focused on the user’s needs.
![Page 17: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/17.jpg)
Hyper/Word Services Offers…
Training • Consulting • DevelopmentFlare • Flare CSS • Flare Single SourcingRoboHelp • RoboHelp CSS • RoboHelp
HTML5ViziAppsSingle sourcing • Structured authoring
![Page 18: Tc dojo presentation writing mobile documentation](https://reader033.vdocuments.us/reader033/viewer/2022061120/546cfe52af79597b298b5211/html5/thumbnails/18.jpg)
Thank you... Questions?
www.hyperword.comTwitter: NeilEric