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.
This message was inspired by the conversation on the list about future
functionality. Like the original post-er, I am re-writing an old manual.
However, my manual is 6 years old and the software is at least 10 years old.
In addition, the old software was DOS. The new version has been completely
re-done in a Windows environment. As a result, I'm writing mostly from
scratch. I keep running into questions about 1) referencing the old
software, and 2) how much to explain about a Windows operating system [vs.
DOS].
In addition to adding new customers, we're hoping to upgrade our existing
clients to the new software. That audience knows the old system and may or
may not know how to operate Windows. Here are some questions:
Should there be an explanation of changes doc? If so, what does that look
like?
Have any of you ever written a specialty doc for existing customers of new
software that is actually old software re-done? How did you handle it?
We do include a "Basics" chapter at the beginning of all the application
manuals. Should that chapter directly address some "basics" when dealing
with Windows? Or, again, should that be a separate document?
I'd love to hear your thoughts. Thank you.
Jessica Nealon
Jessica Nealon
Documentation Intern
IT Audit
McKesson, Inc.-CLT
(704) 549-7239
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
TECH*COMM 2001 Conference, July 15-18 in Washington, DC
The Help Technology Conference, August 21-24 in Boston, MA
Details and online registration at http://www.SolutionsEvents.com
---
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.
