Re: Formatting Docs On-The-Fly

Subject: Re: Formatting Docs On-The-Fly
From: rjstevenson -at- sprynet -dot- com
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 15 Dec 2005 11:25:36 -0500 (GMT-05:00)

Only if one believes that those violations are an ineradicable characteristic of documentation.

If people are constantly violating the formatting standards, I would dig in to see if the problem is with the format (perhaps it needs to be more flexible) or the people (maybe no one explained why Section Foo is necessary).


-----Original Message-----
From: Tony Markos <ajmarkos -at- yahoo -dot- com>
Sent: Dec 15, 2005 11:15 AM
To: CB Casper <knowone -at- surfy -dot- net>, techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Formatting Docs On-The-Fly

On a past TW assignment, I had edited/rewrote alot of
procedures written by network engineers. As the job
was at a DOD agency, we had a standard format/style.
However, that format/style was often violated. In
correcting these situations, I noted that the reason
for such violations was almost always the same:
Getting creative with the format/style was an easy way
for the writer to mask "holes" in his/her
understanding of the subject at hand (i.e, if I do not
fully understand the subject, then a way around the
situation is to "modify" the style so that it fits
what I do know).

Is not such modifying the style on-the-fly such a
wide-spread issue that structured Framemaker is bound
to be of limited use?

Tony Markos

Rebecca Stevenson
Technical Writer
AIM: RJSWriter

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: The resume grinder
Next by Author: Re: Software Requirements Specification
Previous by Thread: Nature study: Wikipedia as unreliable as Brittanica
Next by Thread: RE: Formatting Docs On-The-Fly

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

Sponsored Ads

Sponsored Ads