RE: Quick Guide (2 pages) for complex system (200 p manual)

["Cardimon, Craig" <ccardimon -at- M-S-G -dot- com>]

Deborah wrote:

I need to write a quick start guide for a complex medical system.

The system itself has 200 pages of documentation. The complexity is in
the setup and safety issues, as well as the user's knowledge when they
begin to work with the system.

Could anyone suggest some links for me to go to for examples of other
quick start guides (not necessarily medical), or suggestions on how they
would approach such a project? I'd like to get out of my box and try and
see some new ideas so that I can approach this project with a fresh
perspective.

Thanks in advance for any thoughts/suggestions you may have.

My response:

Hi, Deb,

I would recommend you start here:

Quick Reference Guides: The Poetry of Technical Writing
<http://www.idratherbewriting.com/2008/07/06/quick-reference-guides-the-
poetry-of-technical-writing/> 

http://www.idratherbewriting.com/2008/07/06/quick-reference-guides-the-p
oetry-of-technical-writing/

 

This is a really good post on the art and craft of writing a quick
reference or quick start guide.

 

 

Craig Cardimon

Technical Writer

Marketing Systems Group

ccardimon -at- m-s-g -dot- com

 


*****************************************************************************************************************************************
  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 gives you everything you need to author and 
publish quality Help, Web, and print content. Perfect for technical 
authors, developers, and policy writers. Download a FREE trial.
http://www.componentone.com/DocToHelp/

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- 

To unsubscribe send a blank email to 
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/ for more resources and info.