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.
When document writing does not have or follow guidelines...
Subject:When document writing does not have or follow guidelines... From:"Cara O Sullivan" <cara_osullivan -at- modusmedia -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 7 Dec 2001 09:39:37 -0700
Ouch, Ellen. I feel for you. This is exactly what I faced when I started
this position six months ago. I think someone else already recommended the
following order, and I agree with them:
1. Do the template first. From this you can build your style guide later.
Provide some very simple, straightforward instructions if any non-writers
must do writing. I can email you a sample of this from Ms. Baer, another
subscriber on this list who gave me hers as an example. (This list is great:
I'm totally devoted to it!).
2. Organize youself with a version control system and a standad directory
structure. You're going to need it in a fast-paced environment.
3.. Keep a notebook out on your desk or a file open into which you can write
or type company termininology. You can then meet with others to figure out
the standard meanings, spelling, and other treatments.
Good luck and hold on to your hat!
Cara O'Sullivan
Documentation Writer
Testing & Deployment Group
Global Development, Modus Media International
Orem, Utah
Ph. 801-431-8550
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
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.