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:FWD: Consultant challenges/editing style From:"Eric J. Ray" <ejray -at- RAYCOMM -dot- COM> Date:Thu, 22 Oct 1998 05:12:26 -0600
Name withheld upon request. Please reply on list.
*************************************************
I recently interviewed with a company I will be assigned to as a consultant,
but I am at a loss for lack of prior, in-depth experience in the particular
tasks and responsibilities I would be assigned.
I have determined the following during my interview:
1. The first project would entail reading and reviewing a business I.T.
solution proposal, to integrate and automate daily business activities. This
has been written by the Manager of I.T. and is approximately 90 - 95%
complete. I would need to complete, polish and refine this document before
presentation to upper management and possibly the owners of the company.
Most of these individuals have a minimum of a Masters degree.
2. Develop a style or styles that are both extremely technical, yet easily
and enjoyably read. It must take hold of their attention so they actually
read it.
3. Once the I.T. project is approved, I would then need to transpose this
for a more general audience, the rest of the departments within the company.
I have written and edited technical manuals before, but my audience was
strictly engineers, most with poor or no English skills. I also didn't need
to add "personality" to my documentation, although I do have a creative
style. I just haven't used it.
What I am looking for is input from you, and possibly list members, on
specific books, articles, samples and prior firsthand experiences in this
particular situation.
I have purchased the following titles:
The Chicago manual of style --- 14th Edition
Technical editing : a practical guide for editors and writers/
Judith A. Tarutz.