Path: bloom-beacon.mit.edu!senator-bedfellow.mit.edu!faqserv From: sibit@datasrv.co.il (Russ Hersch) Newsgroups: news.announce.newusers,news.questions.newusers,news.answers Subject: FAQs about FAQs Supersedes: Followup-To: poster Date: 8 Dec 1994 14:48:08 GMT Organization: none Lines: 629 Approved: news-answers-request@MIT.EDU Expires: 21 Jan 1995 14:45:43 GMT Message-ID: NNTP-Posting-Host: bloom-picayune.mit.edu Summary: This article is a description and primer on Frequently Asked Questions (FAQs). X-Last-Updated: 1994/12/08 Originator: faqserv@bloom-picayune.MIT.EDU Xref: bloom-beacon.mit.edu news.announce.newusers:741 news.answers:30747 Archive-name: faqs/about-faqs Posting-Frequency: monthly Last-modified: Dec. 8, 1994 This article is a description and primer on Frequently Asked Questions (FAQs) articles and lists. The following topics are addressed: 1) WHAT ARE FAQs? 1.1) What does FAQ stand for? 1.2) How is FAQ pronounced? 1.3) What do FAQs contain? 1.4) What are FAQs used for? 1.5) Where are FAQs found/kept/hidden? 2) WRITING A FAQ 2.1) Who may write/compile a FAQ? 2.2) Why write a FAQ? 2.3) What subjects are appropriate? 2.4) What is the format for a FAQ? 2.5) What is the maximum size of a FAQ? 2.6) What is a header and do I need one? 2.7) Do I need to copyright my FAQ? 2.8) How do I post/distribute a FAQ? 3) APPROVAL FOR *.ANSWERS - THE BIG TIME 3.1) Why bother getting a FAQ approved for *.answers? 3.2) How do I get my FAQ approved? 3.3) FAQ maintainers 1) WHAT ARE FAQs? 1.1) What does FAQ stand for? FAQ is an acronym for Frequently Asked Questions. It is also sometimes used as the singular Frequently Asked Question (although when was the last time you only heard one question?). A compilation of Frequently Asked Questions (and their answers) is referred to as a FAQ list or FAQ article. Sometimes the term FAQ itself is used to refer to the article - as an example, I refer to this article as a FAQ about FAQs. FAQs fall into the realm of articles called "Periodic Postings". In addition to FAQs, other articles or compilations of information are posted and/or archived. 1.2) How is FAQ pronounced? FAQ is pronounced three ways: 1. By pronouncing the letters individually: F - A - Q 2. As a word: fack 3. Obscenely:
The first two pronunciations are the most common, and are used about equally. Some will say F - A - Q if they are speaking with someone that really doesn't know the Internet. Those who are lazy (me for example) will use "fack", since it is easier to say. Often when initiating a conversation it is useful to say F - A - Q, and then once the subject has been established, "fack" should be sufficient. You will notice that in this document I use the phrase "a FAQ" rather than "an FAQ". This is because most of the time I say "a fack" instead of "an F-A-Q". Feel free to use whichever pronunciation you prefer and don't let anyone bully you. Both ways are acceptable. If you use the third way... well, you're on your own. 1.3) What do FAQs contain? FAQs are compilations of information which are [usually] the result of certain questions constantly being asked (posted) in a newsgroup - hence the name FAQ (Frequently Asked Questions). It seems that those who frequent USENET are a polite bunch. In my house, the "frequently asked questions" that my three rug rats come up with are usually referred to as stupid questions or pestering. There is a lesson to be learned from this... before asking a question in a newsgroup or mailing list, make sure that you've checked out the appropriate FAQs. A frequently asked question can be a stupid question if the answer is posted right in front of your face in one or more FAQs. Sometimes a FAQ or periodic posting is compiled as a result of extensive research on a specific subject. A convenient way to share the information with others is by posting the article. In this case, the article might not really be a FAQ - that is, it isn't necessarily based on frequently asked questions. However, the term FAQ is somtimes used as a catch all term for articles, periodic postings, compilations, etc. It is becoming common practice to refer to some "off-line documentation" as FAQs. Yes, it's true, off-line documentation still exists, I actually saw some a little while back ;-). All sorts of stuff now comes with support-staff-written FAQs, whereas they would have been called Q&A sections before. 1.4) What are FAQs used for? Before asking a question in a USENET newsgroup, check out the appropriate FAQs. If you can't find the answer to your question there, then you can post your question to the newsgroup. Frequently asked questions in a newsgroup tend to make the news hard to read. With more news traffic, there is more to sift through. Do everyone a favor, first try to find the applicable FAQs. Then read them. If you can't find them, look for them. If you still can't find them, ask where they are. Then read them. 1.5) Where are FAQs found/kept/hidden? 1.5.1) USENET FAQs can be found all over the Internet. The most common place to find FAQs are in USENET newsgroups. Many newsgroups have a FAQ specific to the subject of the newsgroup. It is also common, in some newsgroups (that by nature cover more ground), to have a number of FAQs on different, pertinent subjects. Some FAQs that have been approved by the *.answers moderators team (more on this in section 3) appear in the various *.answers newsgroups (news.answers, comp.answers, sci.answers, etc). A quick browse through these newsgroups will turn up many interesting articles - do yourself a favor and check from time to time. 1.5.2) Mailing lists Many mailing lists also have their own FAQs. Some mailing lists automatically mail the FAQ to the list of subscribers. Other lists send a notice advising subscribers how to get a copy. The second option seems to be the most prevalent. An important reason for this is that most FAQs are fairly large (some are even multi-part), and it wouldn't make sense to periodically mail it out to an entire mailing list. Some mailing lists automatically mail the FAQ(s) out to new subscribers (probably with the hope that this will avoid stupid questions), and then letting the subscriber retrieve updated versions of the FAQ(s) by ftp. 1.5.3) Archives Many FAQs are also archived. One important repository of FAQs and other articles is the news.answers archive maintained by the moderators of the news.answers newsgroup. To access these FAQs, ftp to rtfm.mit.edu (or one of the mirror sites) and look in the directory /pub/usenet. Every newsgroup and major subject has its own subdirectory. As an example, if you are looking for one of my FAQs on microcontrollers, look in /pub/usenet/microcontroller-faq. There you will find three entries: 8051, 68ch11, and primer. Instead of searching through the archive, many of the periodical postings on USENET are listed in the news.lists newsgroup under the heading: "List of Periodic Informational Postings, Part * *" These lists are archived at /pub/usenet/news.lists with the archive names: "List_of_Periodic_Informational_Postings,_Part_*_*" If you do not have access to anonymous ftp, you can also send e-mail to mail-server@rtfm.mit.edu to get FAQs by e-mail. Initially, try a message with no Subject: and just the following lines in the body: help end One useful command is the index command. This returns a list of the contents of a particular directory. Some examples of how to use this command are: index index usenet-by-group index usenet-by-group/news.announce.newusers index usenet-by-group/news.answers Be warned that news.answers has a LOT of information in it. The directory listing that will be sent to you by Email will be LARGE. 1.5.4) World Wide Web If your system has a browser for the World Wide Web, then you can access all of the USENET FAQs found in news.answers in the HTML document: http://www.cis.ohio-state.edu/hypertext/faq/usenet/FAQ-List.html You can also telnet to one of the following WWW servers: www.cis.ohio-state.edu www.kuleuven.ac.be (search K.U.Leuven space, can search for any word in a FAQ) The World Wide Web uses hypertext links, contained in HTML (hypertext markup language) documents, to join pieces of information located either at the same or different sites. The links are in the form of URLs (uniform resource locators), a standard way of coding the location of hypertext information. Check with your system administrator or on-line service for more information on how to access the World Wide Web. 1.5.5) Collections and Compilations on CD-ROM This is a controversial subject among FAQ maintainers. Even my mentioning this subject puts me in danger ;-). Many FAQ maintainers (such as myself) object to the practice of some firms grabbing everything available from the USENET archives (including many copyrighted FAQs), putting it on a CD-ROM, and then selling it. The basic objection to this is that the FAQ maintainer works hard at compiling and maintaining the FAQ. We don't mind sharing our knowledge for free, it just isn't fair for someone else to make a buck at it. In addition, this practice is illegal. Most FAQ maintainers have a copyright statement, along with the phrase "all rights reserved", appended to their FAQ. Therefore, the FAQ maintainer, and no one else, has the right to do whatever (s)he wishes to do with the FAQ. If you come across such a FAQ (with the appropriate copyright statements) in a commercial collection, please notify the company you purchased it from that what they are doing is illegal. It would also be appropriate and appreciated if you would notify the author of the FAQ that his/her FAQ is illegally being sold. Many popular magazines have advertisements for collections on CD-ROM of Internet/USENET archives. I cannot verify whether they adhere to the proper legal practices in the compilation and distribution of the contents of their collections. 2) WRITING A FAQ 2.1) Who may write/compile a FAQ? 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. 2.2) Why write a FAQ? 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 10K) 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 about 60K in size (probably needs to be a multi-part FAQ) 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. 2.3) What subjects are appropriate? Just about anything. If you see the same questions always popping up in your favorite newsgroups, and you know the answers, 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, is to be sure to make your FAQ 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. 2.4) What is the required format and style for a FAQ? No format is required. You are free to be as creative as you wish. Keep in mind however, that the FAQ should be readable. Don't just cobble together a document that has no organization or flow. It is highly recommended that you establish a consistent and easy to read format. For this document I chose to use a hierarchical numbering system, but you may prefer another method (e.g. Roman numeral, Capital letter, number, small letter). Indenting the text also makes it easier to read the document (Ask just about any graphics artist, and they will tell you that white space is important). If you prefer a particular formatting technique, by all means use it. Just please keep in mind that everyone will get more out of your efforts if the result can be easily read. In addition, a FAQ can be in straight ASCII, or in several other special formats. I prefer using straight ASCII since it is more easily accessible to a larger number of users. One proposed format is "FAQs: A Suggested Minimal Digest Format". This article is posted periodically to: news.admin.misc, news.software.readers, news.answers The author is: clewis@ferret.ocunix.on.ca (Chris Lewis) This article is also archived as: faqs/minimal-digest-format Another format is the html document standard for use on the World Wide Web (WWW). This is becoming a popular way to "publish" information, however there are some disadvantages: - HTML is NOT an easy-to-understand language - not everyone has access to the Web Grammar and spelling are also important. Poor grammar can cause ambiguities and make it difficult for the reader to understand what you're trying to say. Spelling mistakes are distracting, and can also create confusion. Although it isn't necessary to work towards a doctorate in Enlish literature, take a few moments to review your work and clean it up. 2.5) What is the maximum size of a FAQ? FAQs have no size limit, although sometimes a system may impose certain restrictions - 64K is always a magic number. I've also seen 100K used as a limit. In addition to system limits, FAQs that are very large (over 64K) might be difficult to handle. You might consider splitting your FAQ up into pieces, with each piece having its own theme. Many old USENET sites will not accept articles over 64k. Some on-line services have smaller limits (32k for America Online). FAQ maintainers have to make a trade-off between the universality that they wish their FAQ to achieve, and the convenience of one large article as opposed to several smaller articles. 2.6) What is a header and do I need one? A header contains descriptive information about your posting. If you post your FAQ by means of a newsreader, a [minimal] header will be supplied automatically. This header is required by the posting mechanism. Providing additional header information isn't really crucial unless there is a specific need (such as providing a version number). If you are considering submitting your FAQ for *.answers approval, certain header information is required. See section 3 for more details about this. If you aren't worried about approval for now, then you don't need to worry about the header either. 2.7) Do I need to copyright my FAQ? If you invest a lot of time in your FAQ, and most FAQ maintainers do, you might want to consider including a copyright. This protects your rights if someone else decides to steal your work and make a buck from it. As mentioned above in section 1.5.4, it is very common for companies to compile information from the Internet, put it on a CD-ROM, and sell it. While a copyright won't prevent this from happening, it at least makes it illegal and gives you legal recourse if you need. Under the Berne Convention (to which the US is a signatory), as soon as something is published, then the writer/producer of the item is held to own its copyright. You CAN add (C) copyright 1994 if you want, but it is no longer necessary. Check the copyright FAQ for details. 2.8) How do I post/distribute a FAQ? If you only need to post your FAQ to one or two USENET newsgroups (or mailing lists), then you can just manually post it whenever the posting date rolls around. It is also possible to cross post it to several groups at once. Check with your system administrator for more details on how to do this. Some sites don't keep their news around for a long time, so your posting might disappear from those location sooner than you planned. For this reason, and to allow general access to your FAQ, it is a good idea to archive it somewhere if possible. This might be on a friendly ftp site that agrees to keep the current copy available for ftp'ing, on a mail server, or on your own system (as long as others have some sort of access). If your FAQ is to be posted to a large number of newsgroups, then it might be a good idea to take advantage of the faq-server set up by the *.answers team. The faq-server can be used to automatically post any periodic posting that is first approved by the *.answers team. It allows automatic posting at set interval to as many newsgroups as required. A big advantage of using the faq-server is that it is quick, easy, and automatic. Check with the *.answers team for more details on this. 3) APPROVAL FOR *.ANSWERS - THE BIG TIME 3.1) Why bother getting a FAQ approved for news.answers? When your FAQ is approved for posting to one or more of the *.answers newsgroups (news.answers, comp.answers, sci.answers, etc), it is brought to the attention of those who might not be regular readers of the newsgroup(s) that you usually post your FAQ. This means that a larger potential audience gets a chance to know about your hard work. One of the major reasons for getting your FAQ approved by the news.answers team, is that a FAQ that is posted to one of the *.answers newsgroups is automatically archived. This is important since some sites purge old postings more frequently due to lack of space. The archive makes your FAQ available anytime someone wishes to ftp it from rtfm.mit.edu (the archive site) or any of its mirrors. Another important reason to get your FAQ approved, is that you can then use the faq-server to automatically post to whichever newsgroups you want. Last, and least or most (depending on your personality), there is always the fame and glory associated with being a FAQ maintainer. Once your FAQ becomes widely read and distributed, you will be amazed at how many times your name will be mentioned in postings or other articles. 3.2) How do I get my FAQ approved? In order to get a FAQ approved for posting to news.answers, you need to submit your FAQ to the *.answers team. For a detailed explanation of what you need to do to make your FAQ *.answers compliant, read the *.answers guideline. Check in news.answers to see if it is posted there under the heading "news.answers submission guidelines". If the document isn't currently available at your site, send a mail message to mail-server@rtfm.mit.edu with the command "send usenet/news.answers/news-answers/guidelines" (without the quotes) in its body. You can of course ftp the document from the same place. Getting a FAQ approved is easy and doesn't require much on your part. The most important consideration for approval is a proper header. A minimal example follows: From: sibit@datasrv.co.il (Russ Hersch) Newsgroups: comp.robotics,comp.realtime,sci.electronics,comp.answers,sci.answers,news.answers Subject: 68hc11 microcontroller FAQ Followup-To: poster Approved: news-answers-request@MIT.EDU Summary: This article is a collection of information sources on the Motorola 68hc11 line of microcontrollers. Archive-name: microcontroller-faq/68hc11 Posting-Frequency: monthly This is a real live header taken from one of my FAQs. Another example would be the header to the FAQ you are currently reading. The news.answers guideline document clearly explains the purpose of each line of the header. To make things simple, you can just take the above example and adapt it for your FAQ. Just a few cautions: - All of the fields in the above header are required and all must be included. There are additional, optional fields which may be included if you want to take the time to figure out what they're used for. Personally, I'm too lazy. - The Newsgroups line must have one space after the colon. All of the newsgroups must be listed on one line with no spaces or extraneous characters (which is why the Newsgroups line seems to fall off of the edge of this document - it is not a mistake). - Followup-To must specify either "poster" (which directs followups back to the author of the FAQ) as done above or the home newsgroup of the FAQ (which directs followups to the newsgroup). Do not forget this field since responses then might be directed to the news.answers team, and they will not be very happy about that. Do NOT put an E-mail address in the "Followup-To:" field. - *** IMPORTANT *** The Approved heading is ONLY used when your FAQ is actually approved. When you are notified by the news.answers team that your FAQ has been accepted, then you may add this line to your header. DO NOT include this field until your FAQ is approved, or you will find yourself in deep doo-doo. - For a multi-line summary, the second line of the Summary field should start with at least one space. - One blank line should appear before the Archive-name line. - Archive-name should be fairly descriptive but short. If you aren't sure about this, take your best shot at it and the *.answers team will adjust it if necessary. Once you've added the appropriate header to your FAQ, you can submit it to the news.answers moderators for approval. Send it to the following address: news-answers@mit.edu. Don't expect an immediate answer as these guys are REALLY busy. They will send you back a letter indicating if your FAQ has been approved, and if not, what needs to be done to get it in order. If you have any questions, don't be embarrased to ask the news.answers moderators, that's what they're there for. Most of the time, the problem is simpler than you think. As you gain more experience, things will become clearer. Send your questions to: news-answers-request@mit.edu. To get your FAQ approved for posting to *.answers, you need to do the following: 1. Get (as described above) the "news.answers submission guidelines" article before you do anything. This is a good reference document which discusses many details that I chose not to delve into. 2. Make sure your FAQ is accurate. If you've already been posting it, then your readers have probably already helped you out on this. If you prefer, you can begin by posting the article marked as "DRAFT" a couple of times, to get feedback - then submit it for approval. 3. Make sure that your FAQ is organized so that the material is easily accessible to the reader. 4. Similarly, make sure your FAQ is formatted nicely (proper margins and indentation). This really helps when trying to read it. 5. Prepare a header (as described above) to add to the beginning of your FAQ. 6. Submit your FAQ for approval. The address for submitting your article: news-answers@mit.edu - ONLY for submissions (no questions!) The address for requesting information and for asking questions about the process: news-answers-request@mit.edu 7. Please be patient and don't ask the moderators about the status of your submission. They are very busy and are not able to deal with "nuisance" mail. Use your judgement - if your teenage daughter was in Kindergarten when you submitted the article, then you might be justified in sending them a note. If she was only in fourth grade, think twice. 3.3) FAQ maintainers Once your FAQ is approved, you are now included in the fraternity of elite individuals known as FAQ maintainers (FAQers might not be the best term for obvious reasons). Pass out cigars, throw a party, have a beer, and write and tell your mom about it. So what now? Well, you should prepare yourself for Email. Possibly lots of it. You've now become a "personality" on the Internet (as Jonathan Horen, a good friend of mine put it), and you will more than likely become a central address for those who have questions about the topic that you've addressed in your FAQ. Enjoy yourself - you will end up "meeting" a lot of very nice people from all over the world. These new friends of yours will help you keep your FAQ up-to-date. Everyone will benefit. You might also consider joining the faq-maintainers mailing list. This is used for discussion about the *.answers newsgroups and the maintenance of FAQs. There is also faq-maintainers-announce list, which is used only for announcements. Subscribers to the faq-maintainers list automatically receive messages sent to faq-maintainers-announce. Traffic on the faq-maintainers list is sporadic and the topics eclectic. I haven't yet decided whether I consider this mailing list useful or not. Lately, the traffic has been heavy and (in my opinion) not very interesting. Try it out for yourself and see if you get anything out of it. You can always terminate your subscription. You may send a subsription request for either one of these lists whenever you want. Please send an Email request to news-answers-request@rtfm.mit.edu with a short message in the body specifying which list you would like to subscribe to. The faq-maintainter list is not restricted only to those who have [approved] FAQs that are posted to news.answers. Anyone who is interested in the fine points of FAQ writing/maintaining is invited to participate in the discussions. If you are considering putting a FAQ together, even if you don't intend on getting it approved, the faq-maintainers list is a valuable source of information, and a good place to ask questions. 4) ACKNOWLEDGMENTS I would like to thank the following individuals who have helped and contributed to this document: Jonathan Horen (a real personality in his own right) for his brilliant technical support and who has finally stopped calling me a Techo-Wimp just because I don't know UNIX Ping Huang (a true gentleman and a scholar), Thomas Koenig, and the rest of the news.answers moderation team for their valuable help in getting my various FAQs approved for news.answers and who have provided important suggestions to this document Mark Moraes (the news.announce.newusers moderator) for his valuable contributions and continuing support Mark Brader who provided comments and suggestions on the draft version of this document Michael Bernardi for providing copyright information Rodrigo Vanegas Shane Caple for the information on the World Wide Web Herman VanUytven for the information on the K.U.Leuven WWW server My three rug rats (son Menachem, and daughters Michal and Edya) for your "frequently asked (stupid?) questions" :-) __________________________________________________________ Copyright (c) 1994 by Russell Hersch, all rights reserved. This FAQ may be posted to any USENET newsgroup, on-line service, or BBS as long as it is posted in its entirety and includes this copyright statement. This FAQ may not be distributed for financial gain. This FAQ may not be included in commercial collections or compilations without express permission from the author. ----------------------------------- Russ Hersch - sibit@datasrv.co.il