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.
I am VERY new to this biz -- about a month ago I got a job at Iprax, a
developer of software and courses for interactive training. My first
mission is to write specifications. Fortunately I don't have to know the
C++ calls, but I am to describe every single interface item and its
function. So far my supervisors are pleased with my work, but they're
not tech writers. So I'm wondering: Am I doing this right?
I was wondering if anyone out there had some general suggestions on
spec-writing that I could use. I've looked for STC publications on the
subject and found none. Any comments or help will be GREATLY
appreciated.
Amy Brown
amyb -at- iprax -dot- com
TECHWR-L List Information
To send a message about technical communication to 2500+ list readers,
E-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send administrative commands
ALL other questions or problems concerning the list
should go to the listowner, Eric Ray, at ejray -at- ionet -dot- net -dot-