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: New TECHWR-L Poll Question (design specs) From:"Laura A Mac Lemale" <lmaclemale -at- paychex -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 16 Jan 2001 10:50:07 -0500
Hello:
In my current position, I'd have to say that the design docs are extremely valuable. I am working on at least two projects for which the system specs are the only available resources, because the UI is not fully formed and I don't have the luxury of alpha/beta access.
Previously, I worked in the software industry. We reviewed the specs for every project, but we also had alpha/beta versions of the software with which to become familiar.
Though I miss having that system access, I've learned to fully appreciate the specs. You learn to dig deeper for information, and you really get a feel for how system components fit together. You do have to wade through a lot of information, but you can use the different versions of the specs to track the system
changes as the project moves forward.
Another benefit: Working independently, you can get much of the background information on your own, ensuring that your meetings with SMEs and other team members are more efficient and productive in the long run.
I am intrigued by John Garison's description of the tech writer's involvement in the spec development at his company. (Since becoming a tech writer two years ago, I've only been involved in projects with existing specs in the development phase.)
And I'm curious if the tech writer's role described by John is standard in other companies...
Regards,
Laura MacLemale
Technical Writer
lmaclemale -at- paychex -dot- com
Disclaimer: Usual disclaimer applies....
John Garison wrote:
"Here at IDe, all features to our products are designed by cross-functional
teams (which include tech writers). As part of these feature teams, writers
are involved in taking the preliminary product ideas and fleshing them out
into both functional specs as well as detailed design and technical specs..."
DebRay writes:
Given your current projects, how valuable are product
design documents or specifications?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**WEST COAST LOCATIONS** San Jose (Mar 1-2), San Francisco (Apr 16-17) http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Sponsored by DigiPub Solutions Corp, producers of PDF 2001
Conference East, June 4-5, Baltimore/Washington D.C. area. http://www.pdfconference.com or toll-free 877/278-2131.
---
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.
