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.
Re: Would like your opinion...(Reference to Related Documentation)
Subject:Re: Would like your opinion...(Reference to Related Documentation) From:"Bill Swallow" <techcommdood -at- gmail -dot- com> To:SB <sylvia -dot- braunstein -at- gmail -dot- com> Date:Tue, 21 Aug 2007 14:55:17 -0400
"A" sounds pretentious. A good rubber chicken flogging should cure that.
Go with what makes sense, not what academia thinks.
Me, I use "see X on page n" convention for print and "see X" for
online (both print and online are hyperlinked).
On 8/21/07, SB <sylvia -dot- braunstein -at- gmail -dot- com> wrote:
> S >> If you need to reference, you should say, refer to the Switch User
> Manual listed under Section ...
>
> [A] I think that sounds too long winded. I like "…refer to Switch User
> Manual [1]". This is a standard form. If the reader doesn't know what that
> means he has not read many academic works in his life, IMO.
--
Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager http://techcommdood.blogspot.com
avid homebrewer and proud beer snob
"I see your OOO message and raise you a clue."
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-