I wanted to provide some information on our product documentation, how it is integrated into each product, and how to access it from our web site.
For each product we will provide a web-based documentation and help system that describes, soup to nuts, how to deploy, manage, and get the most out of your
DTO product.
We create different versions of help based on the type of user that is accessing it. This means that if you are, for example, a club coordinator you would see only the
DTO Clubs documentation that pertains to club coordinators and end users. If you are an administrator you would be able to see documentation for administrators, club coordinators, and end-users of the product.
Our help is currently accessible from two main areas:
- from within the product installed on your site
- from our web site
Let's start with how to find documentation through the Drive Thru Online website.
- Go to www.drivethruonline.com
- Click on the Support tab and select the Documentation item
- For the product and version you are interested in click on the appropriate link
- This will open a new window with the full doc (all user types) set that you can browse, search, and reference as you see fit.
From within the product on your web site you'll find help in both the AdminCP (ACP) and user-facing interfaces.
AdminCP
In the navigation menu for
DTO Clubs click on Documentation to open the full administrative doc set in the right-hand frame. Alternatively right click (or option-click on the Mac) and select open in new window for a stand-alone window with the doc set displayed.
End User-facing interface
In this case
DTO Clubs provides an automatic vBulletin plugin into the standard vBulletin navbar. Selecting help from this menu determines what usergroup permissions you have relative to clubs (administrator, coordinator, or end user) and displays the appropriate version of help.
In this example the user was a club coordinator and is shown the documentation for coordinators and end users.
All of our products will include this type of documentation. The following is a list of additional information included in our product documentation:
- screen captures of actual installations
- best practice use of features
- recommended configurations
- notes on differences that may appear due to the version of vBulletin installed
- additional resources for information
Let me know if you have any questions relative to our product help and documentation.
Thanks!
Mark