FAQ system
| From: | Jim Winstead | Date: | Sat, 12 Jun 1999 18:50:06 +0000 |
| Subject: | FAQ system | ||
| Groups: | php.dev | ||
| Request: | Send a blank email to php-dev+get-6852@lists.php.net to get a copy of this message | ||
There was some discussion on the PHP list about this, but
it quickly degenerated into "design the ultimate cool system
that nobody will ever implement, let alone use".
This may also overlap somewhat with the new website structure.
Here's my idea:
* Simple form that has "Question", "Answer", "Category", and
"Submitter".
(I don't have a real list of categories in mind yet. Probably similar
to the list of bug categories, if not identical.)
* Entries are kept in a simple database.
* When a FAQ is answered in the docs, the answer becomes a
reference to the docs.
* FAQ entries can be marked 'reviewed' and 'important' by people with
CVS access.
* The "important" entries are used to generate a single-page FAQ
like what exists at http://www.php.net/FAQ.php3.
* "Reviewed" entries are available via a simple browsing interface.
* The non-reviewed entries can be made visible in the browsing
interface by hitting some magic button.
I'll sign up to implement this.
Bonus idea:
* An email submission mechanism that listens at faq@php.net,
entering the entry with the Subject as the question and the
body of the message as the answer.
I'll sign up to do this when the primary system is up and running.
Ideas that are death:
* Accepting questions without answers.
* Intelligent parsing of questions to provide answers.
* Wholesale integration with the manual.
* Integration with the bug database.
Somebody else would have to step forward for any of these.
Jim