How to help with Documentation

Andrew Boon posted 26th of August 2010 in . 1 comment.

I was pleased to see some messages from people willing to help us with improving BoonEx Documentation, but not knowing "where to start". I realise that any work on docs requires a lot effort, so I only ask for periodic, short contributions. This will get us started and more people would get involved. So, some of the things you can do:

 

Editing BoonEx Wiki

Only Advanced and Premium Members can edit BoonEx Wiki. You would also have to login again with your Unity username and password. Once you're logged-on, just click "Edit this page" button to start adding content. Wiki formatting is a little weird, but is OK once you get used to it.

Troubleshooter

If you had a problem and received a working solution at forums or elsewhere, or if you know about a common problem (even without a solution), post it to Troubleshooter. We will check your edit and will add more information. Once we have a long enough list, we'll split it into separate pages.

Beginner's Guide

If you still remember your first day at BoonEx and the major "frustration points" you've had, start dropping lines into Beginner's Guide. Even rough ideas will do, we'll work on them and will compile proper descriptions. Oh, and if you're a Dolphin Guru and care to shar eyour knowledge - just add whatever you think noobs should know about Dolphin and BoonEx.

Dolphin Administration Guide

This section has been dormant for a good while, but it's really important. In fact, most of the forum discussions and questions arise from problems during site administration. Almost everyone has something to contribute to Dolphin Administration Guide - tips on how to manage profiles, explanations on Builders and site settings, etc. Don't worry too much about structuring your contributions - we'll pick'em up and sort'em out.

Dolphin FAQ

Now this is an easy one. Even if the question is no-so-frequently-asked, go ahead and add it to the Dolphin FAQ. We (or you, or somebody else) will answer it and we'd have a fancy list.

Dolphin Users FAQ

This document is for the members of your sites. Together we can collect a list of most common question Dolphin-sites members ask and you can use this list to make Help/FAQ sections of your sites. How cool is that?! Just add common questions that pop-up in your mailbox and we'll build a collaborative database for everyone to use!

There's more to it...

...than just helping BoonEx. Good documentation is the best possible productivity "booster" for all of us. Good Documentation = less support overhead = faster development = less-loaded Agents = more happy members = satisfied sites' members = better world.

Here's the Documentation Index. There're many pages there, not only the ones I've listed. Take a look and consider giving us a hand.

 

 
Comments
·Oldest
·Top
Please login to post a comment.
annabel
LOL ... the "frustration points" chapter will be quite extensive :-)

In my case, that was 3 years and at least 6 versions ago, so I don't really remember my frustrations. But searching the forum and blogs is a good tool to start with.

I'll add some of my ideas.
 
 
Below is the legacy version of the Boonex site, maintained for Dolphin.Pro 7.x support.
The new Dolphin solution is powered by UNA Community Management System.
PET:0.047111034393311