Re: best documentation

Subject: Re: best documentation
From: Martyn Thirlway <thirlwaym -at- USOFT -dot- NL>
Date: Thu, 11 Jul 1996 08:40:00 PDT

IMHO, the worst manual I have seen was for a product called SoftSpeak (made
in the UK somewhere). It was completely in the wrong order, it was
"un-funny", and basically confusing. Jokes about Conan the Librarian did not
amuse me. The list of files that were on the diskette (for checking) was in
Chapter 5 or 6 I think. But other, reasonably good manuals have been let
down by one or two bombs, such as the Index being incorrect, the
illustrations being unreadable, or the language being just plain weird.

Martyn Thirlway
thirlwaym -at- usoft -dot- nl
Author of "Writing Software Documentation - A Practical Guide"
["This writing business, pencils and what-not. Overrated if you ask me."

TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-

Previous by Author: Re: Converting Ventura
Next by Author: Re: Electronic books/PDF drawbacks
Previous by Thread: Re: best documentation
Next by Thread: Re: best documentation

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

Sponsored Ads