This tool is intended to create a system by which Faqs can be created, modified, deleted, and searched in a more automatic way. It will take the manual labor out of Nathan Dors' hands, and allow for the collection of metadata such as Faq age, owner, etc.
The already existing Postgres database that Router's Ref uses will store three tables for use by the Faq Tool.
It is also possible that Router's Ref will access this information directly to provide its Faq searching interface.
This module will provide an interface to the database for the other functions of the Faq Tool. This will allow changes made to the database to be reflected in one central location.
As data about the use of faqs is scarce, it should also be mentioned that this module is in an excellent position to do extensive logging regarding the use and searching of Faqs.
These scripts will allow a chosen user to update both the public web pages and the common directory with the latest versions of all the Faqs.
This will essentially replace FaqFiNDeR in providing an online location for searching the Faqs. It will, however, be searching the database, rather than the collection of flat files.
The script that is used to provide this online search is the other proposed interfaces with the Router's Ref Faq Search.
This web tool will handle all changes to the actual Faqs. It will allow users to log in via Netid, and will then display a list of faqs which they own/can change. The user will be able to create, modify or delete any of these faqs. A new or changed faq will be marked as "pending."
These Faqs may be editable in a textarea style box, or could be updated by uploading a text file.
In addition to this function, a logged in user can also review any faq which is pending. Viewing a pending faq will also give the user an opportunity to make suggestions or comments. These comments will be recorded or sent to the owner of the faq.
Finally, a chosen administrator will be able to modify any faq. The administrator will also be required to "sign off" on any pending faq so that that new faq, or new version, may be put into circulation.