Re: Structuring Documentation

Subject: Re: Structuring Documentation
From: Tony Markos <ajmarkos -at- yahoo -dot- com>
To: Tony Markos <ajmarkos -at- yahoo -dot- com>, Dick Margulis <margulisd -at- comcast -dot- net>
Date: Tue, 13 Dec 2005 06:43:00 -0800 (PST)

Dick Margulis asks of Tony Markos:

Before you were asking what a structured document was,
implying you doubted that such a thing existed, and
now you've just described two documents as sharing a
common structure [an end-user manual and a properly
done software requirements specification]. So do you
believe that it is possible to write a structured
document or don't you?

Tony Markos responds:

I had previously asked on this listserv if strutured
WRITING existed (outside of formatting considerations
- a relatively minor thing). I specifically asked
what were the concrete, specific steps involved in
structured writing. I got none - only a couple of
comments that it is basically a mysterious,
illdefinable black art that "ya just gotta know".

Addtionally, a fair amount of research on my part
revealed nothing more than loosey-goosey sound bites
as to what structured writing is - no concrete,
specific steps.

(In all candor, to me, all the above is confusing
as I was, prior to this inquiry, told that the major
skill set of a Technical Writer is skill in structured
writing.)

I did read (pretty sure on InfoMapping web site) that
Charles Horn (structured writing guru) says that
structured writing is really all about analysis. I
also read this on other web sites - which,
additionally stated that actual writing is but a small
part of structured writing.

MY BELIEFS:

* It is very possible to properly sturcture a
document - indeed I do this all the time. However,
the creation of a structured document is mainly all
about proper analysis.

* Structured WRITING (again, outside of minor
formatting considerations) does not exist.
>


__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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! http://www.webworks.com/techwr-l

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. http://www.componentone.com/TECHWRL/DocToHelp2005

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Follow-Ups:

References:
Re: Structuring Documentation: From: Tony Markos

Previous by Author: Re: Structuring Documentation
Next by Author: Re: Documenting A Ballet Dance
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