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.
Many thanks to all the people who provided me with valuable input on
what to include in the "handover" document. Here is a list of the items
that I'll include in this document:
- A description of the Tech Writer position (responsibilities)
- Procedures used to start and end a project (information plans, content
specification, project wrap-up reports, etc.)
- Description of previous projects
- Description of future projects and pointers on how to proceed
- Responsibilities of SMEs & software developers (who is responsible for
which product/product component)
- Structure of documents
- Style guides used
- How to use the templates
- Location of files (source & others) with a description of each
version.
- Directory structures used
- File Naming convention
- Troubleshooting section: issues encountered with the current software,
possible workarounds, etc.
- Software used: configuration, changes for new projects, where to get
infos, mailing lists, web sites etc.
- A thorough description of graphics handling
- Contact information (just in case)
Cheers
Manjeet
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.