RE: Need tips on Quick Start Guides

Subject: RE: Need tips on Quick Start Guides
From: "McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com>
To: "John Posada" <jposada99 -at- gmail -dot- com>, "Cardimon, Craig" <ccardimon -at- m-s-g -dot- com>
Date: Thu, 22 Jan 2009 15:52:51 -0500

He didn't say whether it was for software, hardware, or a combination.

Depends on the industry and on the requirements the QSG must meet.

Mine just has to get the customer to the point where they start to
install the software (at which point my main docs become available), so
most of the QSG is pictorial stuff related to hardware, connecting
things, etc.

Also, for Common Criteria compliance for the type of product we sell, a
checklist is required that verifies the "paper" and handling trail of
the received product, so I include that as the first two pages of my
QSG. If you don't pass that, don't bother following the rest of the
booklet - just pack it up and call somebody; there's been a security or
handling breach somewhere.

- Kevin

> -----Original Message-----
John Posada offered:
> Subject: Re: Need tips on Quick Start Guides
> > Looks like I need to create my first Quick Start Guide.
> >
> > Any hints or suggestions would be appreciated.
> Find a QSG on the net that you like and do what they did, but with
> your own words, of course. :-)

The information contained in this electronic mail transmission
may be privileged and confidential, and therefore, protected
from disclosure. If you have received this communication in
error, please notify us immediately by replying to this
message and deleting it from your computer without copying
or disclosing it.


ComponentOne Doc-To-Help 2009 is your all-in-one authoring and publishing
solution. Author in Doc-To-Help's XML-based editor, Microsoft Word or
HTML and publish to the Web, Help systems or printed manuals.

Help & Manual 5: The complete help authoring tool for individual
authors and teams. Professional power, intuitive interface. Write
once, publish to 8 formats. Multi-user authoring and version control!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Please move off-topic discussions to the Chat list, at:


Need tips on Quick Start Guides: From: Cardimon, Craig
Re: Need tips on Quick Start Guides: From: John Posada

Previous by Author: RE: Networking Groups - downside?
Next by Author: RE: Networking Groups - downside?
Previous by Thread: Re: Need tips on Quick Start Guides
Next by Thread: RE: Need tips on Quick Start Guides

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

Sponsored Ads