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:Followup Report: supervising an extreme novice From:Michele Marques <mmarques -at- USA -dot- NET> Date:Tue, 15 Jun 1999 14:04:25 EDT
Thank you, again, to everyone who offered advice. Although an extreme novice
to the world of technical communications, my assistant is very bright, and I
now have a pretty good help file for a small application. Soon she will be
starting work developping help for a slightly larger application.
To those who are curious, here is how I broke down her tasks and training:
- Read an article about help systems and problems/advice
with them.
- Research the application. I gave her very specific questions to
answer, and follow-up questions based on her initial research.
Basically, she took notes on all aspects of the UI and on procedures.
- Read another article about help systems and different types of help
topics.
- Work through the HAT tutorials. (We're using ForeHelp.)
- Develop a help file on a non-computer topic of her choice (she chose
cooking spagetti).
- Initial planning for the help file. She looked over the article again
on different categories of help topics and fit her notes into these
categories. This also helped determine where she needed additional
research.
- Develop the help file. This was very directed. I told her how I would
like the notes divided into various topics, started her with text-
only, edited her work, and requested specific screenshots and a
specific help TOC organization.
For the next project, I will discuss each stage (research, planning,
development) before she proceeds, but am hoping she will not need as much
direction.
If you are wondering how small this first application was - it is only for
performing simple inquiries (no user input except to login).
Michele Marques
mmarques -at- usa -dot- net
____________________________________________________________________
Get free e-mail and a permanent address at http://www.netaddress.com/?N=1