Passing the Flame

Subject: Passing the Flame
From: Manjeet Singh <msingh -at- scort -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 05 Dec 2000 14:57:01 +0100

Hi All,

I'm leaving my current job, and have been asked to write a document
which provides information on the documentation set (PDF & online help)
that I'm leaving behind. This document is intended for the technical
writer who will replace me (I won't get to meet him/her before I leave).
Has anyone on this list already written such a document? If yes, could
you provide me with some pointers on what I should include in this
document? Here is a list of items that I'll be including in the
- Location of files (source & others)
- Description of previous projects (complexity, information plans,
content specifications, planning, etc.)
- How to use the templates
- Directory structures used
- File Naming convention
- Responsibilities of SMEs & software developers (who is responsible for
which product/product component)
- Description of future projects
- Troubleshooting section

FYI, I've checked the archives, and did not find anything relevant.

Thanks in advance.

Manjeet Singh

Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. 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!
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 for more resources and info.

Previous by Author: registration/crop marks in WORD
Next by Author: The "Handover" Document (was Passing the Flame)
Previous by Thread: Re: hcw.hlp
Next by Thread: RE: Passing the Flame

What this post helpful? Share it with friends and colleagues:

Sponsored Ads