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:summary - getting contractors up to speed From:Miki Magyar <MDM0857 -at- MCDATA -dot- COM> Date:Thu, 28 Jan 1999 09:26:10 -0700
My thanks to all of you who responded - your comments helped me a lot. Our current final plan is to have a 3-ring binder and associated legacy material for the incoming contractor, with his/her name on the cover page. Contents:
=========
When you work as a contractor for McDATAʼs Technical Communications department, you can expect to know what youʼre expected to do and how to tell if itʼs done right, and be provided the needed resources and support.
You are here info:
maps of McDATA with location of people, printers, coffee pot, restrooms, etc.
who to call for what kinds of help - annotated phone list
formal and informal rules (ʽask your managerʼ list)
copy center stuff, supplies
printer access
whatʼs online on McWeb
policy on references and samples of work
project name crib sheet
McDATA info, industry and FC basics (Marcom press kit)
Process and tools:
file naming conventions
file organization for projects - templates, project files, graphics
storing and archiving files
generic time line - intervals for review cycles (mark ʽyou are hereʼ)
review and approval process - whatʼs required at each stage
graphics - where to find them, how to pull them in
(for illustrators - examples, plus detailed specs on format and style)
tools and template info - what you can and canʼt change
style guide, list of acronyms, and a glossary
Project-specific:
detailed written task instructions
product description (Chapter 1) and marketing materials
doc plan with current final due dates
source documents - hard copy and/or directory info
SMEs - who and where they are
reviewers - who and where they are
legacy documents as models
editing checklists
Tech Pubs provides:
fully functional cube with working PC and/or Unix station, and phone; installed software, internet access, e-mail, and any other required tools
working badge
a contact person with answers to your questions - if youʼre not sure, please ask!
guided tour and personal introductions to key people
trip down to production to see an actual product
notification of all relevant meetings and updates on source docs
===============
I've also turned this into a one-page handout for contractors to use when interviewing with job shops of potential employers. You are welcome to copy and modify as you wish:
==============
Contractorʼs Wish List
When I walk in, I'd like to find:
A fully functional cube with working PC and/or Unix station, and phone; installed software, internet access, e-mail, and any other required tools
A contractorʼs badge or ID (if you use them)
A contact person with answers to questions
A guided tour and personal introductions to key people
A trip down to production to see an actual product, or access to real software
Resource materials and background information on the project
Notification of all relevant meetings and updates on source docs
Project-specific:
detailed written task instructions
product description and marketing materials
doc plan with current final due dates
source documents - hard copy and/or directory info
SMEs - who and where they are
reviewers - who and where they are
legacy documents as models
editing checklists
Process info:
file naming conventions
file organization for projects - templates, project files, graphics
storing and archiving files
generic time line - intervals for review cycles (mark ʽyou are hereʼ)
review and approval process - whatʼs required at each stage
graphics - where to find them, how to pull them in
tools and template info - what I can and canʼt change
style guide, list of acronyms, glossary
You are here info:
map with location of people, printers, coffee pot, restrooms, etc.
who to call for what kinds of help - annotated phone list
formal and informal rules
who to ask about printer access, copy center, supplies
policy on references and samples of work
project name crib sheet (if relevant)
any background material on the industry or jargon
I understand that e-mail, web access, fax, copier, and phone are corporate tools. I will only use them for personal tasks within reason, subject to good taste, legal restraints, and professional etiquette.
==========
I hope this helps someone. Thanks again -
Miki
mikim -at- ieee -dot- org