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: Documentation Correctness was Re: How many levels of indents andheads are reasonable?
Subject:RE: Documentation Correctness was Re: How many levels of indents andheads are reasonable? From:"Sandi Castle" <sandi -at- siberlogic -dot- com> To:"'Richard Lewis'" <tech44writer -at- yahoo -dot- com> Date:Wed, 17 Oct 2007 12:23:35 -0400
Gosh, everyone is so grumpy!
Here's a concrete product that actually addresses the implementation, if not
the theoretical importance, of interrelationships.
SiberLogic has integrated task analysis with product knowledge modeling.
Product facts in the repository are linked via identified
relationships/constraints using RDF/OWL; tasks are derived from linked
usecases; draft DITA-based documentation can be generated automatically;
documentation development is both accurate and complete.
-----Original Message-----
From: techwr-l-bounces+sandi=siberlogic -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+sandi=siberlogic -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Richard Lewis
Sent: Wednesday, October 17, 2007 9:22 AM
To: Bill Swallow
Cc: Ned Bedinger; techwr-l List
Subject: Re: Documentation Correctness was Re: How many levels of indents
andheads are reasonable?
Please tell me of one source that discusses the importance of rigorously
identifying the interrelationships between tasks.
Thanks,
Generic Richard
Bill Swallow <techcommdood -at- gmail -dot- com> wrote:
Tony, where the heck do you come up with this stuff? I can't speak for
all schools, but I certainly studied task analysis (many methods)
while obtaining my degree in communication.
On 10/16/07, Richard Lewis wrote:
> Richard Lewis responds:
>
> 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 interrelationships between the tasks.
Unfortunately, nobody within the TW community - either in academia or
industry - has discussed this. So incorrect documentation is pretty much
gauranteed.
>
> Generic Richard
--
Bill Swallow
HATT List Owner
WWP-Users List Owner
Senior Member STC, TechValley Chapter
STC Single-Sourcing SIG Manager http://techcommdood.blogspot.com
---------------------------------
Looking for a deal? Find great prices on flights and hotels with Yahoo!
FareChase.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 sandi -at- siberlogic -dot- com -dot-
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-