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.
Procedures for Documentation for Release and Upgrades to Software
Subject:Procedures for Documentation for Release and Upgrades to Software From:shannon -dot- morris -at- gen21 -dot- com To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 27 Mar 2001 11:24:24 -0800
I have checked the archives to no avail. I am a lone tech writer and I
have been set as the point for all RFPs and technical questions from other
departments, apart from creating manuals and help. I end up creating a lot
of content and then forwarding it on to Marketing for editing and audience
re-work.
Since we are about to release a new version of our software I am getting a
lot of requests for documentation explaining the new functionality. I
would like to implement a repeatable process, so I turn to you. Do any of
you have procedures in place for the type of documentation that you create
to help facilitate information flow throughout an organization when
anticipating a new release or upgrade. Aside from my manuals, I am
thinking of something along these lines:
-Definitions of new terminology
-Descriptions for new functionality (which will be used to create a
Features and Benefit List and a Technical Overview)
-Release Notes (which are currently being done)
>From there I am stumped. I can't think of any other examples or process
flow. If any of you have suggestions they will be greatly appreciated.
We have so many documents floating around, obviously for different
audiences but I want to improve this process, especially since it begins
with me. I get the digest so if you could reply to me off-list.
Thanks
Shannon Morris
Sr. Technical Writer
Generation21 Learning Systems
1536 Cole Blvd, Ste 250
Golden, CO 80215
www.gen21.com
(303) 233-2100
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
