Re: Poll: How do you differentiate commands, etc. in text?
What do each of you do (if anything) to emphasis text for online use?
So far, I am doing something like this for procedures:
Less is more. The simpler you can make the styling, the clearer it will be to the reader and the less likely you and your coworkers will screw up in implementing the style.
I use--and recommend--caps and lowercase to name things. Period. Press Enter. Type your name in the Name field. The Customer Account window opens. Click the New Address button. Etc. (Those are not meant to constitute a sequence of steps; they're unrelated examples.)
I've suggested before, and apparently convinced a few people that it makes sense, using caps and lowercase when referring in documentation to longer UI labels, even if sentence case is used for the labels themselves. For example, if a Print dialog has a field labeled "Number of copies," I would refer to it in documentation as the Number of Copies field.
Using caps this way and avoiding font changes, bolding, italics, etc., meets Edward Tufte's criterion of "least perceptible difference" and serves your purpose well, I think.
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content delivery. Try it today!. http://www.webworks.com/techwr-l
Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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%40infoinfocus.com
To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.
Poll: How do you differentiate commands, etc. in text?: From: Diana Ost
Previous by Author:
Re: batch printing jpg files
Next by Author: Re: Did I overreact?
Previous by Thread: RE: Poll: How do you differentiate commands, etc. in text?
Next by Thread: Poll: How do you differentiate commands, etc. in text?
Search our Technical Writing Archives & Magazine