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.
Subject:Re: Passing the Flame From:"Jane Bergen" <jane -dot- bergen -at- usa -dot- net> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 5 Dec 2000 09:14:02 -0600
Yes, I have and it's very helpful to both the new person, obviously, but
also to you (keep a copy) to help you get on paper all your job
responsibilities. One thing I would add to your list is a procedures list
for starting and ending a project. In the one I wrote, I explained how to
wrap up a project, archive it, where to store it, what to put in the
archive, etc. I also included a corporate style guide that I had started
(corporate style guides are never "finished" anyway).
It was a lot of work, and I started it for my own sanity as a lone
writer....but it came in handy when I did decide to move on. The new
person should have been able to read it and pick right up where I left
off.
> 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
> document:
> - 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
> www.scort.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
