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.
> -----Original Message-----
> On Behalf Of Zuercher, Darrell
> I like the phrase, "barely sufficient documentation". Write just
> enough so that the audience can accomplish its work. As someone
> (I can't remember the source at the moment) once said, "Make it
> as simple as possible, but not simpler.
Generally attributed to Einstein.
You can make a pretty good argument that not just the intermediate
stages, but also the final documentation should be "as simple as
possible, but not simpler." It is way too easy to keep piling on stuff
that looks useful, but just gets in the way.
XML for Technical Communicators http://xmlpress.net
Use Doc-To-Help's XML-based editor, Microsoft Word, or HTML and
produce desktop, Web, or print deliverables. Just write (or import)
and Doc-To-Help does the rest. Free trial: http://www.doctohelp.com
Explore CAREER options and paths related to Technical Writing,
learn to create SOFTWARE REQUIREMENTS documents, and
get tips on FUNCTIONAL SPECIFICATION best practices. Free at: http://www.ModernAnalyst.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-