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: FAQs - Good or bad? From:"Joe Malin" <jmalin -at- tuvox -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Fri, 13 May 2005 12:26:53 -0700
Dear Steve,
Interesting question! I am always facing that myself, and in fact I
wrote a documentation plan which *proposed* having FAQs as part of the
documentation.
You probably have to do some digging to find out what they really want.
You may have something better than FAQs, or you may need to come up with
a new "book." You may even need to investigate the issue.
My experience is with programming tools. How do I document all the
little tips, tricks, ideas, paradigms, etc. that go into using a
computer language effectively? Think about all the books that have been
written about "effective" software development!
I have been thinking that we should have a discussion forum for internal
use. From that forum, someone could pull out the most important ideas
and summarize them in a knowledge base/FAQ document/whatever.
This is not going to go away. For every tool we as tech writers use, we
have discussion forums, FAQs, knowledge base articles, and so forth. For
this genre of technical documentation, what is *our* role as technical
writers?
Joe
-----Original Message-----
From: bounce-techwr-l-216553 -at- lists -dot- techwr-l -dot- com
[mailto:bounce-techwr-l-216553 -at- lists -dot- techwr-l -dot- com] On Behalf Of Steven
Brown
Sent: Friday, May 13, 2005 11:20 AM
To: TECHWR-L
Subject: FAQs - Good or bad?
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.
