"How To Write Usable User Documentation", (by Edmond Weiss)

Subject: "How To Write Usable User Documentation", (by Edmond Weiss)
From: beverly_robinson -at- datacard -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 6 Dec 2004 09:38:02 -0600






Several years ago a colleague who was in the Computer Science master's
degree program at a local university asked to be allowed to write a user's
manual as his class project. The professor wanted it written following the
principles in Dr. Weiss's book (although the book was out of print at the
time). I ended up rewriting the entire manual before release.

The textbook for the class I'm currently taking is "Murach's C#" (by Joel
Murach and Doug Lowe, ISBN 1-890774-22-7). It uses the two-page spread
style quite successfully, although it took me a while to get used to it. My
instructor tells me that many of the Murach books use this technique.

Beverly


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!

RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Previous by Author: Robohelp X5 HTML Help Master books - difficulties in the beginning
Next by Author: Re: layout duties
Previous by Thread: Re: Right-justification
Next by Thread: robohelp vs. webworks


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


Sponsored Ads