RE: Structuring Documentation

Subject: RE: Structuring Documentation
From: "Johnson, Tom" <TJohnson -at- starcutter -dot- com>
To: "Tony Markos" <ajmarkos -at- yahoo -dot- com>
Date: Tue, 13 Dec 2005 11:01:20 -0500

Tony said something I can't get a grasp on, to which I respond:

If you can think it, you can write it. If you can think in a structured way, you can write it down in a structured way. Some people have a harder time doing it than others. The trouble is some people don't see the structure and have a harder time getting started. They have to find a different approach to organizing the information. I suppose you've found a way that works for you. Perhaps your mind visualizes information in a way that others can't. Make it work for you, but please stop saying everyone else is wrong because they can't visualize the same way you do.

I suppose there are those who never figure out how to structure information and they see nothing wrong with steps in a random order. My children see a neat floor, I see random clutter. My job is to train them to see things out of place. Technical writers have been trained, we can only hope, to present things in a logical and ordered manner.

I would also suggest several levels of structure exist. On one end would be the structure of words. Then the structure of sentences and on to procedures and paragraphs. Finally, the order topics are divided into sections and books. There's more structure out there than some people are giving credit for.

Tom Johnson
Technical Writer
tjohnson -at- starcutter -dot- com

-----Original Message-----
From: techwr-l-bounces+tjohnson=starcutter -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+tjohnson=starcutter -dot- com -at- lists -dot- techwr-l -dot- com]On
Behalf Of Tony Markos
Sent: Tuesday, December 13, 2005 10:44 AM
To: Spreadbury, David; Dick Margulis
Subject: RE: Structuring Documentation


I did not define structured writing - I said that it
does not exist. Analysis exists - espcially
structured analysis, and writing exits. But I have
found no evidence that structured writing exists as a
seperate entity.

Now Shipping -- WebWorks ePublisher Pro for Word! Easily create online
Help. And online anything else. Redesigned interface with a new
project-based workflow. Try it today!

Doc-To-Help 2005 now has RoboHelp Converter and HTML Source: Author
content and configure Help in MS Word or any HTML editor. No
proprietary editor! *August release.

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Documenting A Ballet Dance?
Next by Author: RE: The resume grinder
Previous by Thread: RE: Structuring Documentation
Next by Thread: RE: Structuring Documentation

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

Sponsored Ads

Sponsored Ads