Re: Press this, or just Press

Subject: Re: Press this, or just Press
From: "Gene Kim-Eng" <techwr -at- genek -dot- com>
To: "Milan Davidovic" <shl_ctf -at- yahoo -dot- ca>, "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 1 Mar 2007 10:32:27 -0800

My approach generally is to have the callout say,

<Function Name> Button

and if the function name is not self explanatory,

<Function Name> Button
<Short description of what the button does>

I don't think think I've ever written for an audience
that could not be preassumed to understand that
when something is called a button you press it (or
if it's an image of a button in SW, click it) to make it work.

Gene Kim-Eng


----- Original Message ----- From: "Milan Davidovic" <shl_ctf -at- yahoo -dot- ca>

This question is intended for tech writers who create
call outs that instruct the reader to press a button
(or some such) illustrated in the figure, and draw a
line with an arrow from the call out to the button in
question.

The question: in the call out, do you write "Press to
<do x>" or "Press this to <do x>". I'm curious as to
whether you regard the inclusion of "this" as
redundant.

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

Create HTML or Microsoft Word content and convert to Help file formats or printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
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 admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


References:
Press this, or just Press: From: Milan Davidovic

Previous by Author: RE: Example of quality technical writing: coding style
Next by Author: Re: [TCP] certification (was: ranting STC)
Previous by Thread: RE: Press this, or just Press
Next by Thread: Re: Press this, or just Press


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

Sponsored Ads


Sponsored Ads