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:New at this Game From:"Shannon Morris" <shannon -dot- morris -at- gen21 -dot- com> To:<TECHWR-L -at- LISTS -dot- RAYCOMM -dot- COM> Date:Tue, 27 Jun 2000 10:15:25 -0600
I was recently hired as a Technical Writer and I want to know if you can
suggest any good references. My company is great and I enjoy working here.
My problem is I am fairly new to this field and am not sure how to go about
getting the information that I need to put together some of the documents
that are needed. The company has grown exponentially since last year, from
7 to 50, so they don't have a lot of documentation currently developed. The
only unfortunate thing is my direct manager (VP/CIO) is dealing with a
family crisis and has been unavailable to provide any of the information
needed to begin the work. I have been asked to develop/update all of the
engineering & software specs. My past experience includes writing several
training manuals and documenting a project from start to finish,
additionally I have worked on the technical aspects of a project too. I
have a pretty well rounded background, in education and information systems.
Currently, I have several systems analysis and design texts (one by Dewitz
and the other by Whitten & Bentley), Project Management by Shtub, and a few
technical writing books. Are there any other books you can suggest that
would also provide examples of documents or steps that would include all
aspects of a particular document. Also, are there specific standards for
developing an IEEE document?
I hate to sound like a novice but I think I am and would appreciate any
expert advice.