TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Better way to indicate a variable in doc From:Jeff Hanvey <jeff -at- jewahe -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 22 Oct 2002 13:10:06 -0700 (PDT)
I've seen the following used:
___
xxxx
<variable name> (this is my preferred: it seems to imply something changeable. Also, you can replace the words with the type of data that will be contained within, such as <date>. Of course, a brief explanation of this convention should be explained).
You could also continue using the current convention: however, you *should* explain what is happening. For example: "'Port %s of %s is not answering calls' (where % represents variable data)."
HTH!
Jeff
--- johanne -dot- cadorette -at- locusdialog -dot- com wrote:
>Our administration guide includes a chapter on alarms that are logged by
>the system and sent to the system administrator via email. In this
>chapter, the alarms are organized by their descriptions, that is, the
>short text inside the email message that explains what the problem is (for
>example, "Maximum number of entries reached.")
>
>When there is a variable in the definition, it is represented by %s in the
>documentation. For example, "Port %s of %s is not answering calls;" in
>this case, the message sent to the administrator would read "Port 4 of 8
>is not answering calls"; or, "Your license expired on %s."
>
>I?m looking for a better way to represent the variables. Any ideas?
_____________________________________________________________
Jeff Hanvey: http://www.jewahe.net
_____________________________________________________________
Select your own custom email address for FREE! Get you -at- yourchoice -dot- com w/No Ads, 6MB, POP & more! http://www.everyone.net/selectmail?campaign=tag
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Buy ComponentOne Doc-To-Help 6.0, the most powerful SINGLE SOURCE HELP
AUTHORING TOOL for MS Word. SAVE $100 on the full version and $50 on the
upgrade. Offer ends 10/31/2002 (code: DTH102250). http://www.componentone.com/d2hlist1002
All-new RoboHelp X3 is now shipping! Get single sourcing, print-quality
documentation, conditional text and much more, in the most monumental
release ever. Save $100! Order online at http://www.ehelp.com/techwr-l
---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
