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

Subject: RE: "How To Write Usable User Documentation", (by Edmond Weiss).
From: Tony Markos <ajmarkos -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 6 Dec 2004 11:58:25 -0800 (PST)


The main points in Weiss's book are that:

* User-friendly documentation is documentation in
which the number of skips and jump-to's that the
end-user must perform in reading the documentation is
minimized.

* The way to minimize skips and jump-to's is with
good modular design.

The two page layout thing is not nearly as important.

What Weiss would not say - but I am not afraid to - is
that good modular design depends upon good modular
analysis - data flow diagrams.

Tony Markos

--- "Susan W. Gallagher" <sgallagher5 -at- cox -dot- net> wrote:
>
> > If someone wanted to improve their professional
> knowledge and
> > skills, would people recommend this book?
>
> The book is old -- I read it in 1994 and it was old
> then -- but it is rather
> unique in its advice for paper manuals and I don't
> think the advice has been
> repeated.
>
> It explains how to craft a modular user manual --
> module in this case being
> defined as a technique in which each topic is
> covered in its own two-page
> spread with description here and graphic there and
> procedure in the other
> place and every two-page spread looks exactly the
> same and the information
> is organized identically.
>
> It's an iteresting technique. I wrote a user manual
> that way once ....



__________________________________
Do you Yahoo!?
Yahoo! Mail - Easier than ever with enhanced search. Learn more.
http://info.mail.yahoo.com/mail_250

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

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.



References:
RE: "How To Write Usable User Documentation", (by Edmond Weiss).: From: Susan W. Gallagher

Previous by Author: Re: expanding our range
Next by Author: Re: expanding our range
Previous by Thread: RE: "How To Write Usable User Documentation", (by Edmond Weiss).
Next by Thread: Journalism and Tech Writing


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


Sponsored Ads