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.
Setting up an internal web page with an FAQ is a good idea. Let's face it though, no one is going to read it.
At my previous company, we began using Faq-O-Matic (faqomatic.sourceforge.net) , a CGI-based system for maintaining FAQs. I recommend this because it can be used for far more than just addressing common language or grammatical mistakes. The development team can use it to maintain FAQs about code libraries, best practices, QA processes, etc. One person does not maintain the list, everyone contributes to it. It's developer friendly. Definitely worth checking out at least - and it's free!
~Rasil
-----Original Message-----
From: Mike O. [mailto:obie1121 -at- yahoo -dot- com]
Sent: Monday, January 13, 2003 1:55 PM
To: TECHWR-L
Subject: Re: Unexpected as always!!
Radwa's boss asked her to:
>"Please arrange a session ASAP for both programmers and QC
> about abbreviating, capitalizing, punctuation, and the sort."
I'd teach the class (not that it sounds like you have a choice).
It would be a gas, and would probably be the easiest day's pay
I've had in a while. Try to get a food budget!
Also, why not just set up an internal web page? Look at their
documents, and make a list of the Top Ten most common mistakes
(and provide the correct version, too). If you give them
specific examples they can grep for, it will probably never
happen again, and they might even build a script for it.
Find out which errors bug your boss the most, and make sure
those are fixed.
Mike O.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
A new book on Single Sourcing has been released by William Andrew
Publishing: _Single Sourcing: Building Modular Documentation_
is now available at: http://www.williamandrew.com/titles/1491.html.
Help Authoring Seminar 2003, coming soon to a city near you! Attend this
educational and affordable one-day seminar covering existing and emerging
trends in Help authoring technology. See http://www.ehelp.com/techwr-l2.
---
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.
