help system

[redbullmarky]

Hi chaps

 

I'm currently in the process of constructing a help system for my site. Whilst initially it's a fairly straightforward task, I want to build the functionality into something more re-usable for any purpose for future use. Sometimes I want it to churn out a FAQ, sometimes i might want it to be more like the sort of Help you'd see on an OS

 

So - a few questions:

1, Does anyone have any pointers to any packages that already do specifically this that I can take a peek at?

2, How would YOU personally arrange the DB to handle something future proof in respect of a help system?

 

On the surface, putting together a help system may seem fairly straightforward - it's literally just the future I'm considerate of...

 

but something that could churn out something like:

this

or this - ie, fully fledged - is what i'm aiming for.

 

Cheers in advance for any thoughts/opinions

Mark

[Ninjakreborn]

Since the data is all the same, I would think 3 different parts.

The question, the answer associated with the question, and a category to put the question under.

You want to be able to easily add new question/answer combo's, as well as add new categories.

You want to be able to add/edit/delete questions

You want to be able to associated/deassociated questions/answers with specific categories.

 

I think that would all be pretty straightforward.  The hard part I think would be deciding on the style.  How many different style's you would want the system to have.  I would then create a folder, have 1 css file for each style you want, and have the ability for someone to change it using a GUI.  I would create a GUI for the site itself, an area where people could put in db info, and create the database/tables necessary for it to run, then you can just go back and enter questions/answers and categories as needed.

 

THe system itself, and where everything is, is already setup.

 

Same thing everytime.

 

http://www.sulata.com.pk/greatfaqs/great_faqs/index.php There is something that is already created, to give you an idea of what might be possible.

 

Good luck.

[AndyB]

Usually I add an 'importance' column to the database (enum High, Medium, WhoCares) so that when I add a new FAQ it doesn't just appear at the start or finish but appears in a logical spot (from the user's perspective) in the overall FAQ pagination by cunningly using an ORDER by importance.

[448191]

I've presonally been very charmed by this way of storing data:

 

Modified Preorder Tree Traversal

 

It will allow you to use an unlimited level of subcategories, and will allow reordering of FAQ questions without having to drop and create new tables.

 

I recommend ranking of items and categories to be done by popularity.

 

For searching, a simple fulltext index on questions and answers.

[redbullmarky]

yeah i've looked at that before. definitely one i'll be looking more into, even if not for this particular need.

 

anyway - thanks so far for your suggestions. I'm currently trying a few different ways just to see how they all fit together properly

 

Cheers