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.
We have a choice of two separate processes (described below).
Approach 1 (Our current approach):
* Each writer is responsible for specific manuals
OK, if you re-use chunks/chapters of standard information between *all* the
manuals. For example: each writer uses the one standard introduction
chapter, not their own 'version'.
Make sure you keep a database (even if it's handwritten notes in a folder)
of all the common elements, styles, expressions, headwords for the indexes,
'depth' of explanations, spelling conventions, screen-shot dpi., etc.
Approach 2 (Proposed by higher management):
* Each writer is assigned specific components of the entire product
line, and documents only that component *in each of the manuals*.
Could be a problem if one of your team leaves (for whatever reason)
half-way to the deadline. No-one else in the team will understand that
person's products, will they? And no-one will have time to teach the
Small team + no redundancy + tight deadlines = recipe for disaster.