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: User Guide - best practices From:"Harold B. Gill" <hal -at- web500 -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Sun, 28 Jul 2002 18:37:26 +0200
Good evening,
In our software company, we do document every screen of the software and
this forms the source material for our Online Help and, as a pdf, this
is also a printable Reference Guide. Many of these sections also have
procedures which form a part of our Education section's Tutorial for use
in the classroom
The content of the Tutorial along with some additional material from the
Reference Guide is arranged as a User's Guide which is different in that
material of relevance for different users is gathered together.
We make a Web Content Management System so that means that the User's
Guide consists of sections for the Web Designer, the Administrator of
the system and the Content Author.
We do all of this using FrameMaker 5.5, generating the context sensitive
Online Help using WebWorks Publisher 7.02 Professional.
It works great and our two person tech writing team has managed to
deliver some pretty impressive results using this combination. We are
just about to do a major release in which this Online Help will get it's
first implementation. I am sure I will have more to report in the near
future.
Best regards / Med venlig hilsen,
Hal Gill
Technical Editor
Web500 A/S
www.web500.com
STC-Nordic, Webmaster and Acting President
www.stc-nordic.org
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Buy RoboHelp Deluxe starting at only $798: you'll get RoboDemo, the hot new
software demonstration tool that's taking the Help authoring world by storm,
together with RoboHelp Office. Learn more at http://www.ehelp.com/techwr-l
---
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.