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 a technical writer working for a software company. I write the user
guides and compile the help files. I just came out of a metting where I
have been told that I am on the critical path for our release date of Dec.
5th, 1999. This is no news to me, how can I document something that is not
finished? I will complete my docs and helps at the same time the software
comes out of QA. Can I do better than that?
I started writing my guides based on the specification documents, which
lacked a lot of details. I used the alpha version developers release
internally every 2 weeks to update/modify my guides. I worked in parallel
with them during the coding phase and will work that way until they finish
coding. Is there another faster/better way to work? If the specs were
frozen I could have finished the documentation before the developers
finished coding but the specs are too vague and they change along the way.
I have no choice to use the actual product to really know what it does and
how it does it. Is it that hard to understand?
All answers are appreciated
Thanks
Pierre Roberge
Famic Technologies 2000 (soon obsolete)
Montreal