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.
Re: Definition of "User-Friendly" Was Re: Engineering design practice
Subject:Re: Definition of "User-Friendly" Was Re: Engineering design practice From:"Kathleen" <keamac -at- cox -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 20 Apr 2005 19:12:17 -0700
Being only a writer/editor, I have to say I'm glad we're all human, and
it's unlikely that your ideal will come to pass anytime soon. This is
especially nice because many engineers I've worked with already act like
the user docs are useless. And, why couldn't you extend that process to
the under-the-hood material?
<NO, IT'S NOT OBVIOUS!!!! stamp, stamp>
sorry, had to get that off my chest <g>
>From Gene Kim-Eng
Subject: Re: Definition of "User-Friendly" Was Re: Engineering design
Actually, I think it is the definition of "good engineering practice"
that is more important. Having been an engineer, I would define it as
managing the entire development process, including not just design, but
manufacturing, service and support. This would, of course, mean
producing documentation that provides the user with accurate
information, well-organized information that
facilitates the successful use of the product.
OTOH, really *great* engineering practice would produce a product so
easy to use that user docs would be unnecessary, and the bulk of the
documentation effort would be expended not on user docs, but on
documenting the really complicated stuff running under the hood for the
WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo: http://www.webworks.com/techwr-l
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.