TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
Subject:Re: Using forms instead of templates From:"Paul Strasser" <paul -dot- strasser -at- windsor-tech -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 4 Dec 2001 09:53:58 -0700
First, recognize the fact that you'll probably have to do some editing of
whatever comes back from the developers. No matter how terrific your form
or doc might be, most developers can't write worth a darn anyway.
We use a series of "fill in the blank" technical docs based on templates
I've created. And regardless of how detailed or specific the headings or
instructions are for a doc, each project will be a bit different, so the
steps or procedures will differ. One client's User Requirements doc will
differ from another client's.
In general, though, a bit of tweaking is a lot easier than completely
re-inventing the wheel for every document for every project.
If your templates are clean and logical, one reasonable step is for you to
let the people who are blank-filling exactly which style is used for a
particular process ("use Body Text for all narratives. Use List 1 for
step-by-step procedures. Use Bullet 1 for unordered lists") Even if they
totally muck it up, you know how to fix it.
Good luck
Paul Strasser
Windsor Technologies
Lafayette, CO
more resources and info.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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
---
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.