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.
"Andrew T. Brooke" <abrooke -at- pathcom -dot- com>
>I used to work at a place where the doc standard was to have the first
>sentence in the manual be:
>
>Welcome to the <name of product> <name of document>.
>
--snip some words---
>
>I can't decide if this is:
>
>A) The smelliest opening line ever for a doc, resulting in both
>laughter and/or sickness.
>B) A nice, gentle way to guide the reader (primarily a developer) into
>the great work they are about to enter.
It's probably C) - thrown in because the space seemed bare without *any*
introductory sentence, but there wasn't really a more meaty sentence
that fit. "Like the title implies, this is a user manual. Please use
it. We hope you find it, um, useful."
Have to call this one "font-fondling" ;) If the document flows right by
just jumping in, I'd do it that way, and if it needs an introductory
fluff sentence to avoid seeming abrupt, I'd do that. Not a lengthy
decision either way, in my opinion.
Greg Holmes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Enhance, optimize and automate your FrameMaker-to-PDF workflow with TimeSavers:
Define all PDF features in your source FrameMaker files ONCE, distill MANY.
Bookmark Controller, Link Controller, UnBloat & more : http://www.microtype.com
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! 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.