Alternative to typo?

Subject: Alternative to typo?
From: Geoff Hart <ghart -at- videotron -dot- ca>
To: Technical Writing <techwr-l -at- lists -dot- techwr-l -dot- com>, Joel Wilhelm <eleysium -at- gmail -dot- com>
Date: Fri, 27 Mar 2009 09:12:42 -0400

Joel wondered: <<For some reason I am having trouble coming up with an
alternative to "typo." I have a sentence that says: "A typo in this
command may render the unit unresponsive." Should I change it to, "a
typographical error"? That sounds stuffy. "A mistake in typing..."?
Something else?>>

Strictly speaking, a typographical error would be choosing Times New
Roman for any font designed to communicate with members of this list.
<g> and <stitch> When in doubt, be direct: "If you type this command
incorrectly, the unit may stop responding [to what: your inputs? to
juidicious blows with a hammer?]."

But there are two additional problems here. First and most important,
why (in this day and age) would any sane engineer (if such a creature
exists) allow this to happen? How hard is it to parse the commands
first and refuse to perform such a dangerous command? Why is there no
way to solve the problem? On the other hand, if there is a secret
command that will cause it to begin responding again, revise the
sentence as follows: "If you type this command incorrectly, you will
need to type [reset command name] to reset the unit so it will again
respond to [whatever]."

Second, and no less important, "may" is unacceptably vague: if at all
possible, make the SME tell you clearly and unequivocally when a typo
will and will not cause this behavior, and clearly spell this out for
the reader.

------------------------------------------------------------------------
Geoff Hart (www.geoff-hart.com)
ghart -at- videotron -dot- ca / geoffhart -at- mac -dot- com
------------------------------------------------------------------------
Effective Onscreen Editing:
http://www.geoff-hart.com/books/eoe/onscreen-book.htm
------------------------------------------------------------------------

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.
http://www.doctohelp.com

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control! http://www.helpandmanual.com/

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


Follow-Ups:

References:
alternative to typo: From: Joel

Previous by Author: What's wrong with Times New Roman? Nothing much, really.
Next by Author: Alternative to typo? (take II)
Previous by Thread: Re: alternative to typo
Next by Thread: Re: Alternative to typo?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads