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.
-----Original Message-----
From: McLauchlan, Kevin [mailto:Kevin -dot- McLauchlan -at- safenet-inc -dot- com]
Sent: Thursday, January 22, 2009 3:53 PM
To: John Posada; Cardimon, Craig
Cc: Technical Writing
Subject: RE: Need tips on Quick Start Guides
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.
*****************************************************************************************************************************************
Information contained in this e-mail transmission is privileged and confidential. If you are not the intended recipient of this email,
do not read, distribute or reproduce this transmission (including any attachments). If you have received this e-mail in error, please
immediately notify the sender by telephone or email reply.
*****************************************************************************************************************************************
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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. http://www.doctohelp.com
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! http://www.helpandmanual.com/
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
