Print Page | Close Window

Is there any user guide or admin guide of WWF?

Printed From: Web Wiz Forums
Category: Web Wiz Web App Support Forums
Forum Name: Web Wiz Forums
Forum Description: Support forum for Web Wiz Forums application.
URL: https://forums.webwiz.net/forum_posts.asp?TID=25830
Printed Date: 28 March 2026 at 11:59pm
Software Version: Web Wiz Forums 12.08 - https://www.webwizforums.com


Topic: Is there any user guide or admin guide of WWF?
Posted By: StarDust
Subject: Is there any user guide or admin guide of WWF?
Date Posted: 13 June 2008 at 6:59pm
I would love to have one user/admin guide.

Does anyone know if it has been completed by anyone else? Or is it on the to do list in a future release?

This guide can be very handy both for the webmasters who installs and administers WWF and users of WWF. Also if users have a user guide they will quickly know what they can do by clicking where on the forum.

I propose for five guides.
  1. Installation Guide
  2. Administrator Guide
  3. Moderator Guide
  4. User Guide
  5. Skin Guide

And a bit more detailed:
  • This could be wiki based and also a downloadable pdf/doc
  • Every guide will have three versions - Access, MSSQL and My SQL.
  • Also there could be instructions on installing WWF on IIS7.

I think some specs should be defined. Here is my suggestion:


1. Installation Guide
I think this is currently covered. But including Active Directory integration instructions will be more useful.


2. Administrator Guide
This guide can include a full description of all the features of WWF and steps to be taken to enable/disable or use the features. This guide should also include what is the diffrence between main Administrator and other admins/moderators

Say, with the calendar system, we need to know how we can enable/disable the system. What are the side effects that may impact on the entire WWF system and the server if we enable it or disable it. What we can get by enabling it, how we can use it. Like how we can create an event, record birthdays, how the event is shared amongst other users etc.

What is the significance of email subscriptions, how to enable/disable/use it.

This admin guide should also include but not limited to what are permissions, how we can set them. What can be the result by modifying default permissions or specific permission parameters. May also include description of different scenarios where permissions were modified to achieve a purpose and some result out came.

I think you got the scenario


3. Moderator Guide
Based on the default permissions what a mod can do and what can't.


4. User Guide
They are someone we all care so much. It is better if they can take a glance without experimenting with different links and sections of WWF by clicking. They need it easy.


5. Skin Guide
This guide will come handy for skinners of WWF with all level of experience detailing the CSS of WWF.

If you are interested in having this guide and/or creating it, please comment on. We can only have it from Bruce if we want it. Wink


-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x



Replies:
Posted By: 123Simples
Date Posted: 13 June 2008 at 7:39pm
If Bruce trusts me I'll write one for him Thumbs%20Up
As far as I know there is only what we find on FAQ, installation help and this forum, but great point


-------------
http://www.123simples.com/" rel="nofollow - Visit 123 Simples Web Design


Posted By: StarDust
Date Posted: 13 June 2008 at 9:31pm
Someone should start. If you are going to make one, I'll support that.

And also really appreciate if it is available with WWF download. This is something this worthy application lacks of.


-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: 123Simples
Date Posted: 14 June 2008 at 1:09pm
Thanks Thumbs%20Up
I'll get right on it Wink


-------------
http://www.123simples.com/" rel="nofollow - Visit 123 Simples Web Design


Posted By: StarDust
Date Posted: 14 June 2008 at 7:04pm
Good luck MrTWS Thumbs%20Up

So, all others including the developers/mods - don't you care this?


-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: 123Simples
Date Posted: 14 June 2008 at 7:20pm
Yeh please guys and girlz
We could create a all in one "bible" as such for admin users guide, cos I don't know that much peeps Wacko


-------------
http://www.123simples.com/" rel="nofollow - Visit 123 Simples Web Design


Posted By: Jono
Date Posted: 14 June 2008 at 8:02pm
I wrote a step-by-step installation guide for utilise AD authentication: http://forums.webwiz.net/uploads/24799/Installing_Web_Wiz_Forums_within_an_Active_Directory_Domain.zip - http://forums.webwiz.net/uploads/24799/Installing_Web_Wiz_Forums_within_an_Active_Directory_Domain.zip
We'd need to start with a structure of the document (i.e. main headings) - or better still, put it in a Wiki?


Posted By: StarDust
Date Posted: 14 June 2008 at 8:44pm
Originally posted by Jono Jono wrote:

I wrote a step-by-step installation guide for utilise AD authentication: http://forums.webwiz.net/uploads/24799/Installing_Web_Wiz_Forums_within_an_Active_Directory_Domain.zip - http://forums.webwiz.net/uploads/24799/Installing_Web_Wiz_Forums_within_an_Active_Directory_Domain.zip
We'd need to start with a structure of the document (i.e. main headings) - or better still, put it in a Wiki?


ClapClapClapClapClap

This is just great. This could be an add on to the original download

Clap

-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: StarDust
Date Posted: 14 June 2008 at 9:09pm
I have come up with some ideas. I have modified and included those into my original post. See the first post.

-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: Jono
Date Posted: 15 June 2008 at 8:10am
They look great. The only additional thing to mention is how we accomidate different versions of WWF. For example we would need to identify if an update was a correction to an existing document or reflected a change in version. We obviously don't want to be producing documention for 5 different versions.
 
I'm more than happy to help with the installation document. Tongue


Posted By: StarDust
Date Posted: 15 June 2008 at 8:58am
Originally posted by Jono Jono wrote:

The only additional thing to mention is how we accomidate different versions of WWF. We obviously don't want to be producing documention for 5 different versions.


I didn't quit get you. What do you mean by five different versions? Install docs and some admin functions differ slightly by different database versions of WWF.


Originally posted by Jono Jono wrote:

For example we would need to identify if an update was a correction to an existing document or reflected a change in version.


Updates, critical fixes, minor version changes are beyond the scope of documentation i suppose as the contents in the docs will reflect the effective use and implementation of WWF. Say, if there were docs for v9.x, it could get updated with the release of v10.

For the feature changes in minor versions, if there is any, we can all use the forum.


If you want to contribute, please do so and post your contributions here for the rest of us to see.Tongue




We still didn't hear anything from the Magic Man. What's up? Wink



-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: Jono
Date Posted: 15 June 2008 at 10:26am
Hi StartDust,
 
I meant which version of the software should we support. Although version 7 is no longer support, version 8 is and there are the sub version in between - I didn't phase my point very well, but you got the idea.
 
Therefore, the documentation will support only the latest version of the software.
 
I think a Wiki would probably be the best way forward, and allow easy updating and searching (there's nothing worse than reading a forum topic and finding the information at the beginning has been superceeded!)
 
As it's the weekend (and for once we have some sunshine in the UK!) I suspect Bruce is away from his computer at the moment - it would be good to get his thoughts on this before we proced to far.


Posted By: Scotty32
Date Posted: 15 June 2008 at 10:56am
I agree, a wiki would be far better.

As I don't want the download bloated with documentation i'll never read.


-------------
S2H.co.uk - http://www.s2h.co.uk/wwf/" rel="nofollow - WebWiz Mods and Skins

For support on my mods + skins, please use http://www.s2h.co.uk/forum/" rel="nofollow - my forum .


Posted By: StarDust
Date Posted: 15 June 2008 at 11:54am
A wiki make things easier. I agree but can't help having a downloadable documentation.

If I have a documentation on my PC in PDF or DOC, I don't need to browse the net. Sometimes it is faster and easier.


-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: StarDust
Date Posted: 15 June 2008 at 11:57am
Originally posted by Jono Jono wrote:

As it's the weekend (and for once we have some sunshine in the UK!) I suspect Bruce is away from his computer at the moment - it would be good to get his thoughts on this before we proced to far.


I agree. We, by all means need bruce to agree and approve this to have it official. But unofficially i do not see any problem if someone creates something like the active dir integration instructions (see above). Doing so might make things easier for bruce.

By any mean we need a documentation badly. Smile


-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x


Posted By: 123Simples
Date Posted: 15 June 2008 at 12:54pm
I think a PDF documentation or perhaps a website that can be more controlled than an open forum would be the best solution. I would assume the official side of it would be even more time consuming for a person who already has lots to do, but perhaps an "un-official" How This Is Done type of thing would be advantageous

-------------
http://www.123simples.com/" rel="nofollow - Visit 123 Simples Web Design


Posted By: StarDust
Date Posted: 17 June 2008 at 4:04pm
Still no news from the top man?Shocked

-------------
http://board.ebizbd.net/">Tips, mods and skins for WWF v9.x



Print Page | Close Window

Forum Software by Web Wiz Forums® version 12.08 - https://www.webwizforums.com
Copyright ©2001-2026 Web Wiz Ltd. - https://www.webwiz.net