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:Richard Lewis <tech44writer -at- yahoo -dot- com> To:Gene Kim-Eng <techwr -at- genek -dot- com>, techwr-l List <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 17 Oct 2007 06:41:40 -0700 (PDT)
Currently, I am documenting web middle tier systems. I have to deal with sooo many obtuse, new buzz words that, if I did not have a focus on the essential and , especailly, a focus on interrelationships, I would be totallly lost. Honestly, I really do not see how anyone approaching analysis of such systems without a firm rigorous approach is not pulling out their hair.
Generic Richard
Gene Kim-Eng <techwr -at- genek -dot- com> wrote:
In most of the companies I've worked with, both as an engineer
and a writer, identifying the essential tasks and their interrelations
has been an essential part of successful product development.
The few companies I've worked with where this was left undone
for the documentation team to complete came nowhere near to
anything resembling success.
Gene Kim-Eng
----- Original Message -----
From: "Richard Lewis"
> 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.
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 tech44writer -at- yahoo -dot- com -dot-
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.
---------------------------------
Fussy? Opinionated? Impossible to please? Perfect. Join Yahoo!'s user panel and lay it on us.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
