Using forms instead of templates

Subject: Using forms instead of templates
From: techwriter -at- supalife -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 4 Dec 2001 10:45:53 +0000


Hello
I have been asked to 'sort out all the documentation issues' at a company that
has never had a tech writer or an info manager before.
One of the issues I've been asked to address is the look and feel of our
technical documentation (specs etc) and our user documentation (mostly
straightforward how-tos for in-house end-users).

At the minute docs are written by developers and/or project managers and it
was suggested to me that all I need do is create some templates (different
versions of Word) for them to use. But I've seen the results of previous
efforts at standardisation using templates and am not keen on this as it is
still too easy for them to get it wrong (and worse-wrong because formatting
has to be undone before it can be done properly).

I checked the list archives and recently a couple of people suggested using
forms to get the info from these people, which seems to me like a fantastic
idea. For a number of reasons I've had to rule out HTML forms so am looking
now at Word ones (the only tool available company-wide).

But of course I have a question...

If I used Word forms (with formatting built in) how could I build in some
flexibility? I'm thinking for example of dealing with a different number of
steps or sections. The forms will have to be protected (or the point is
missed!) but I don't want everything to end up back at me for editing...

Have any of you managed this or something similar? Have I missed something
obvious?
I'd be v grateful for any input -- please copy me in on any replies, I'm a
digester!

Cheers
Lil
'Wishing I had a clever sig'



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr

Have you looked at the new content on TECHWR-L lately?
See http://www.raycomm.com/techwhirl/ and check it out.

---
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
http://www.raycomm.com/techwhirl/ for more resources and info.


Follow-Ups:

Previous by Author: [techwr-l-daily-announce] TECHWR-L Daily Update Posting
Next by Author: HTML to man page (Unix)
Previous by Thread: Re: Canada based Tech Writing List
Next by Thread: RE: Using forms instead of templates


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


Sponsored Ads