A grand, grand opening line...

Subject: A grand, grand opening line...
From: "Andrew T. Brooke" <abrooke -at- pathcom -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Sun, 22 Sep 2002 22:31:30 -0400

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>.


Welcome to the Schmaltzherring API Guide.
Welcome to the Imsoferklempt User Manual.

<product names changed to expose the guilty>

I'll be setting up some new docs in a new job, and am not sure if I should
borrow this "standard". 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.

What sayeth thee, my dear tech writing brothers and sisters? Novelists know
that the first line of a novel is the hardest. Well, this ain't a novel, but
a good opening line can't hurt.

Got any good opening lines? Send them in now - operators are standing



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

FrameMaker-to-PDF TimeSavers Assistants let you enhance & automate navigation
in PDF doc sets (chapter tabs, next/prev chapter/pg, bookmarks, popup menus);
create interactive PDF forms, rollover popups; presentations: http://www.microtype.com

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.


Previous by Author: Documenting COM objects
Next by Author: Drafts - the final word?
Previous by Thread: Guide to programming PostScript
Next by Thread: Re: A grand, grand opening line...

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

Sponsored Ads