Q.
Who may write/compile a FAQ?
Answer.
Anyone - no rule exists about who may or may not compile/write a FAQ.
If there is a need for the information contained, your FAQ will be
appreciated.
Q.
Why write a FAQ?
Answer.
The Internet (and USENET) is frequently referred to as the
Information SuperHighway. You can argue the merits of this analogy,
but you can't deny that there's lots of stuff out there. The big
problem is finding it - and I mean BIG PROBLEM. It might be more
accurate to refer to the Internet as "the large, multi-storied,
over-crowded, Information Parking Lot." And the attendant is away!
One thing that I've discovered in the short time that I've been on
the Internet, is the willingness of those who frequent USENET to help
others find their way around this great big wonderful mess. A FAQ is
a good way to help lots of good folks at the same time. The first
FAQ that I wrote was as a result of my search for information on
Intel 8051 microcontrollers. I couldn't find anything for a long
time. I used Archie, Gopher, and lots of other methods that I either
read about or that friends recommended. In addition, I scanned the
appropriate newsgroups. However, all that I could find were the same
questions that I was asking. I nearly came to the conclusion that
the Internet was a waste of time.
After compiling a few facts, I put them together in a small article
(under 5K) and posted it to a few USENET newsgroups that seemed to
have a reasonable connection to the subject matter. In a short time
I was inundated with Email. Readers of my FAQ from all over the
world sent additions and corrections for the FAQ, requests to post to
other newsgroups, kind words of appreciation, offers of free software
and literature, and even a job offer. Today the FAQ is over 100K in
size and two other FAQs were born from the leftovers from this first
FAQ.
As a result of this modest effort, I have learned a lot. I have more
than enough information about the 8051 microcontroller, I learned my
way around the Internet, and I have made connections with a number of
really nice people. Even more, my FAQ had a snowballing affect.
Several other people are now either maintaining or starting FAQs on
other microcontrollers. In a short time, if a newcomer to the
Internet is looking for information on microcontrollers, a pile of
information will be immediately available, without the need for
months of searching. Hopefully, the same will be true about the
subject(s) that you are interested in.
Q.
What subjects are appropriate?
Answer.
Just about anything. If you see the same questions always popping up
in your favorite newsgroups, a FAQ might be needed. First, look in
the USENET archives and ask in the appropriate newsgroups if such a
FAQ exists. If there is no FAQ, and you know the answers (or at
least a good number of them), do yourself and everyone else a favor.
Compile the questions and answers together in an article, and post it
regularly to the newsgroup.
Just as important, make sure that your FAQ is made available to the
right audience. This means carefully choosing which newsgroups to
post it to. Often, requests from other newsgroups will inform you
that others are also interested in your FAQ.
Q.
How important is accuracy?
Answer.
If you are maintaining a listing of all of the Gilligan's Island
episodes (yeah, there is such a FAQ, and it's great!), the chances of
causing serious damage to someone are pretty slim.
However, as a purely hypothetical example:
- if you are maintaining a FAQ on the Pentium processor
- you claim that the Pentium is 100% accurate and bug-free
- someone reads your FAQ, bases a project on this information, and
encounters a bug that has terrible consequences
- at the least, you will be considered vermin by your dear reader
- at the worst, you might find yourself being sued by same
Some FAQs are in the business of sharing information about different
products. This can be a bit touchy when trying to convey quality or
usability. Care should be taken when relying on opinions (even, or
especially, your own) or hearsay. Try to check out the details the
best that you can. You might consider stating if an item is opinion
or fact (whatever that is). Be open for suggestions. The inclusion
of a disclaimer might be called for, although it really shouldn't be
necessary (see section 4.2).