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.
> The applications I document runs on Windows, Linux, and
> Macintosh platforms. On the "System Requirements" page, I
> have only the "System Requirements" header and ...
>
> Windows
> Linux
> Macintosh
>
> Except for the header, each phrase is a hyperlink that
> expands a table containing the application's OS, hardware,
> and software requirements for each platform.
>
> I am partly inclined to add some introductory verbiage, but I
> have resisted since I can't image anything that would add
> meaning. Having selected "System Requirements", the user
> obviously knows what he is looking for. Similarly, he knows
> whether he needs to see requirements for Windows, Linux, or
> Macintosh. He will also understand hyper linking conventions
> (the text is blue, and when hovering, the text is underlined
> and the cursor becomes a hand), and if that isn't enough,
> each phrase is preceded by a +.
>
> Is more verbiage needed? If so, what could I say that isn't already
> (strongly) implied?
No. And congratulations on resisting the urge to add pointless verbiage.
Give yourself a pat on the back and leave well enough alone. :-)
Richard
------
Richard G. Combs
Senior Technical Writer
Polycom, Inc.
richardDOTcombs AT polycomDOTcom
303-223-5111
------
rgcombs AT gmailDOTcom
303-777-0436
------
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-