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:On-line help - programmer's involvement From:Jill Scudamore <jillian -at- YORKU -dot- CA> Date:Tue, 16 Dec 1997 08:58:40 -0500
I work for a large University which has recently finished the
implementation cycle for our new Student Information System. The
programming team has moved into a maintenance phase, and no new
upgrades are expected for quite some time.
I'm starting to investigate the possibilities of implementing
on-line help and context sensitive help. In order for my proposal to
be accepted, I need to provide an estimate of the amount of time
that the programmers will need to work with my files in order to
integrate them into the applications.
Since I have never produced this type of documentation, I'm
completely in the dark. DO the programmers have to work some magic
on my files? If yes, is it a five minute job? Or is this a major
project? The on-line help will be loosely based on my 400 page
manual, so there will be quite a large number of topics.
Unfortunatly, I don't know which tools I'll be using yet, so I can't
give you much information. I do know that I'll be writing the
documentation on Frame 5.5. I'm assuming that I'll be using RoboHELP
also.
Thank you in advance for any information.
Jill.
Jill Scudamore
SIS Training Coordinator
Office of the Registrar
York University
North York, Ontario