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: Online Help Format for P&P: Anyone? From:crawfoa -at- allegiance -dot- net To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Mon, 23 Apr 2001 12:9:36
>Jenise, I recommend using using eHelp's RoboHelp HTML Edition and
generating WebHelp, especially if your audience requires cross-browser
functionality. I used this format to publish our organization's Policy
Guide on our Intranet.
As far as what to call it--- why worry about what kind of format to refer
to it. Perhaps just include "online" to distinguish it from paper, but
otherwise your audience probably won't care. Just refer to it in terms of
the content. "Please see our Policy and Procedure manual at http://internal.yoursite.com/policies.htm [or whatever]."
Jenise Cook wrote:
These questions are not just for the Policy & Procedures (P&P) technical
> writers who quietly lurk on this list. I welcome anyone's contributions.
>
> Are you are publishing your P&Ps in an online format using any of the
> available HATTs (including FM to WWP 2000)? We will be publishing our
> reference procedures on our Extranet, soon, and we're looking forward to
> this project. (Our tool is eHelp's WebHTML.)
>
> One of you (Marguerite?) recommended http://www.plainlanguage.gov. There is
> an example of P&Ps in an online help/Web format, which was helpful:
>http://www.apexsc.com/truehelp1/styleguide/
>
> Another question: How to you refer to your online/electronic format? It's a
> mouthful to say "...procedures in an online help format." Also, the words
> "online help" may not apply to this type of documentation. Sure, procedures
> "help" the audience do what they want to do. But, when I hear "online help"
> I automatically think of a program's help files. Right now, we're using
> "...publishing our procedures electronically." But, that could mean PDF.
> Suggestions?
>
> Thank you,
>
> Jenise Cook-Crabbe
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available 4/30/01 at http://www.devahelp.com or info -at- devahelp -dot- com
Sponsored by DigiPub Solutions Corp, producers of PDF 2001 Conference East,
June 4-6, Baltimore, MD. Now covering Acrobat 5. Early registration deadline
April 27. http://www.pdfconference.com.
---
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.