Re: Style and Procedure Schema?

Subject: Re: Style and Procedure Schema?
From: kcronin -at- daleen -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 6 Mar 2002 14:14:46 -0700


Given your example, it does make sense to standardize within your given
documentation set.

But I don't see the reason (or the feasability) of trying to make the
standardization fit ALL tech writing.

For example, suppose you decide that Chapter 4 is hyperlinking. And
suppose somebody else does not use hyperlinking in their documentation
(not at all unlikely for hardcopy instructions, particularly assembly
instructions). Should THEIR style guide have a blank Chapter 4?

The problem with one-size-fits-all thinking is that it never fits anything

Each job I've held has had style issues to be resolved, and while there
was some overlap in the problems to be addressed, there were also many
unique issues inherent to each specific situation. To try to anticipate
ALL those eventualities in one fell swoop seems like a lot of work for
something of limited/questionable usefulness.

But then, I'm of the shut-up-and-write school. YMMV.

-Keith Cronin

Anagrams for "signature line"
- unite in lagers
- releasing unit
- genius in alert

Check it out! Get some cool freebies when you buy RoboHelp! You'll receive
SnagIt screen capture software and a 10% discount voucher for RoboHelp
Consulting. This special offers expires March 29, 2002.
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

Previous by Author: RE: Style and Procedure Schema?
Next by Author: RE: True insignificance... and release notes
Previous by Thread: Re: Style and Procedure Schema?
Next by Thread: RE: Style and Procedure Schema?

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

Sponsored Ads