A good FAQ page should always be helpful to both parties. Or, post a text version of your FAQ to the cocoon-user list, and ask for comments. This is a good reference document which discusses many details that I chose not to delve into.
Some FAQs require a lot of attention. Consider sharing this knowledge, while it is still fresh, with other users.
Submit your FAQ for approval. Writing documentation improves the design of your code. This really helps when trying to read it. 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.
Compile the questions and answers together in an article, and post it regularly to the newsgroup. Another main FAQ archive is ftp: 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.
Hopefully, the same will be true about the subject s that you are interested in. By making it easy to find, easy to follow and easy to read, you are adding another layer of customer service. The situation as Eugene saw it was that the answers to these questions were are often poorly thought out, inconsistent, and uninformed.
If you post your FAQ by means of a newsreader, a [minimal] header will be supplied automatically. It is important to remember that these are your customers most common questions, not just the things that you want to tell them.
You only get contributions after you have documentation. Camera pans from stage left. Remember to also keep it updated.Feel free to read this document straight through, or simply use it as a reference.
If you don’t write for many months, it is a lot harder to start writing again. Keeping your projects documented will keep you writing at a reasonable cadence. Frequently Asked Questions (FAQ).
How to author an FAQ. Overview.
This How-To describes the steps necessary to write an useful FAQ for the Cocoon documentation project. FAQs are frequently asked questions. However, for many, the word has come to mean a lot more.
These guidelines are based on successful FAQ document structures used by other open source projects with diverse. Note: as killarney10mile.com writes to the document stream, calling killarney10mile.com on a closed (loaded) document automatically calls killarney10mile.com, which will clear the document.
Syntax killarney10mile.com(markup); Parameters More information is available in the W3C XHTML FAQ. Nov 24, · If so update the existing FAQ document else create a new FAQ document.
All recurring questions can be updated in the existing FAQ document. Here is. 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.
How To Write a Great FAQ Page. September 3rd, | copywriter, FAQ Page–If you write within a niche that tends to confuse people, or you find you get a lot of the same questions over and over again, a “Frequently Asked Questions” page can be your best friend.
It’ll save you time and your readers will be thrilled that they can.Download