Re: LONG - A colloquial writing style?
Most of the documentation I find myself writing is less about *learning*
and more about, well...
I don't know how to put it. It's the case of presenting a small snippet
of information that the reader uses to quickly solve a particular task.
They don't have time to "learn", they're just trying to solve a problem.
In that case, what style should we use?
Sure, Joe. The authoring-of-learning-materials contingent is a minority among us. Most of us (at least in the realm of software TW) are writing reference material and user guides.
Even if they "don't have time to 'learn'," we'd like our snippet to be memorable enough that the reader does not have to keep coming back to the same place.....
The ideas and concepts the blog presents are interesting, and the Head First books do appear to be good learning resources for those who need to comprehend Java, EJB, Design Patterns, and the like.
--Guy K. Haas
Software Exegete in Silicon Valley
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a 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.
References:
RE: LONG - A colloquial writing style?: From: Joe Malin
Previous by Author:
Re: LONG - A colloquial writing style?
Next by Author:
Re: Leprosy?
Previous by Thread:
RE: LONG - A colloquial writing style?
Next by Thread:
RE: LONG - A colloquial writing style?
Search our Technical Writing Archives & Magazine
Visit TechWhirl's Other Sites
Sponsored Ads