Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable?

Subject: Re: Documentation Correctness was Re: How many levels of indents and heads are reasonable?
From: Janice Gelb <Janice -dot- Gelb -at- Sun -dot- COM>
To: techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 17 Oct 2007 09:29:20 +1000

Richard Lewis wrote:
>
> It is easy to tell a TW to be correct, but, if that
> is as far as it goes, it is nothing. Being correct
> means having performed a rigorous analysis. Such
> analysis is based on identifying the essential tasks
> to be performed and, most importantly, the inter-
> relationships between the tasks. Unfortunately, nobody
> within the TW community - either in academia or
> industry - has discussed this. So incorrect documentation
> is pretty much gauranteed.
>

Um.... huh?

A quick glance at any STC Conference program or list
of recommended books on technical writing will reveal
a score of presentations and books on task analysis.
I'm afraid you won't be able to patent this idea after all.

-- Janice

***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.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.


References:
Documentation Correctness was Re: How many levels of indents and heads are reasonable?: From: Richard Lewis

Previous by Author: Re: Dialog box/Screen/Window
Next by Author: Re: What is the best term to use?
Previous by Thread: RE: Documentation Correctness was Re: How many levels of indents andheads are reasonable?
Next by Thread: Re: Documentation Correctness was Re: How many levels of indents andheads are reasonable?


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


Sponsored Ads