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: System Architecture / Documentation From:Steven Brown <stevenabrown -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 16 Oct 2001 13:09:41 -0700 (PDT)
Hi Megan,
I think the most important thing to remember is that
the needs of the organization should drive the
documentation. As my boss said to me a few months ago
(and I'm the sole writer, too), "There's a lot that we
could document, but what must we document." That's the
key. Determine which documentation is most important
(using whatever criteria you and your boss agree
upon).
It's tough as the sole writer, because there's so much
you want to do. But rest assured that anything that
you do not commit to your formal documentation set
WILL get documented nonetheless; and if I may quote
Martha Stewart and Diamond Dallas Page, "That's a good
thing." Later, when you have time, you can gather all
of the disparate notes and documents that others have
written and organize them as only a highly trained
technical writer can.
Steven Brown
Senior Technical Writer
P.S. In my situation, due to regulatory requirements
that we intend to meet, requirements are our number
one priority. The architecture stuff (which I love!)
will have to wait.
__________________________________________________
Do You Yahoo!?
Make a great connection at Yahoo! Personals. http://personals.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Announcing new options for IPCC 01, October 24-27 in Santa Fe,
New Mexico: attend the entire event or select a single day.
For details and online registration, visit http://ieeepcs.org/2001
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.
