RE: Agile tech writing

Subject: RE: Agile tech writing
From: "Richard L Hamilton" <dick -at- rlhamilton -dot- net>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 9 Apr 2010 09:49:56 -0600

> -----Original Message-----
> On Behalf Of Zuercher, Darrell
>
><snip>...
> 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.

Richard Hamilton
---------------------------------
XML Press
XML for Technical Communicators
http://xmlpress.net
(970) 231-3624


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

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.

Please move off-topic discussions to the Chat list, at:
http://lists.techwr-l.com/mailman/listinfo/techwr-l-chat


References:
RE: Agile tech writing: From: Zuercher, Darrell

Previous by Author: RE: Houston, we have an auction
Next by Author: Pizzas in the Deep Freeze
Previous by Thread: RE: Agile tech writing
Next by Thread: Re: Agile tech writing


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

Sponsored Ads


Sponsored Ads