Marilyn-

I agree that the documentation needs to show examples of each type of question.  However, I don't think it needs to have any Question-by-Question, Group-by-Group, or All-in-One categories.  Authors can easily switch among those three styles without any changes to the questions themselves.

Also, I'd organize it according to the advanced question options.  Altough you could have headers for show/hide questions and piping, those could all point to the same (potentially new) section of the Expression Manual pages (unless someone really wants to make that many surveys and take screen shots of all of them).

You'd also want to show the interdependence among the advanced question options.  So, for example, if you select min and max numerical value, you get a different effect than if you select just min or max.  Similarly, there are places where  you need to combine questions to demonstrate effects, especially cascading array_filter and array_filter_exclude.  Many of the ls2_* example surveys already show this, as they were used to validate that the features work appropriately.  For example, showing all question types that can be array_filtered in one survey so can easily validate that they all behave identically.

Furthermore, although there are officially 20+ question types, there are effectively over 30 question types.  Users wanting to know  how to use Google Maps, or sliders, or some of the other features wouldn't know to look for the Short Text question.

Better search/indexing would also help.  I often use Google to search for  LimeSurvey features rather than doing so via the wiki.  Not sure if that is something the wiki can fix.

If you do make  many surveys, I recommend taking a look at this new feature - http://docs.limesurvey.org/Excel+Survey+Structure . It makes it very easy to do bulk edit and insert/update of surveys (e.g.  changing question type but keeping the other options, and switching from using sub-questions to answer codes, or vice-versa, without needing to re-enter the lists of options).

Lastly, there are many dynamic features.  It is much easier to see them in action than to read about them on a wiki.  So, I recommend making lots of surveys available that show such features, and create YouTube videos showing how they work.  Narration can by nice, but it isn't always critical.

/Tom



On Tue, May 15, 2012 at 8:12 AM, Marilyn Banister <mkb@work4media.com> wrote:

Hi all,

Looking to see if you all think this would be a beneficial thing to do, if so….I would like to take this on.

 

During my learning process with LS I found it to take me much much longer searching the documentation than expected to find what I was looking for.  I would find one piece to the puzzle and then have to search all over to find the next.

 

Here is my idea:

 

We take each question type and make only ONE example survey that will be used in every link in the documentation (we may need one for each version, I don’t know).
                1. Everyone would update this one document everytime a fix or new feature is added.

                2. The first page would be pipes that go directly to the feature the person wants to see.

                3. Each feature would have a link to the documentation on how to make it work in the HELP area.  This link would take them to the documentation on how to do this feature in ALL the different question types (code for each)

 

For example:

Multiple Choice Type. 

                First page would look like this:  Of course this would be piped ….I just indented so you could see what I am talking about.

                                Question by question

                                                Hide question

                                                Show question

                                                Piping

                                                With exclusion

                                                Etc…

                                                Etc…

 

                                All in one

                                                Hide question

                                                Show question

                                                Piping

                                                With exclusion

                                                Etc…

                                                Etc…

Group by group

                                                Hide question

                                                Show question

                                                Piping

                                                With exclusion

                                                Etc…

                                                Etc…

 

                                With answer Images

                                                Without checkboxes

                                                With hover highlight around images

                               

                                Click and Go

 

 

Or it could look like this:

Multiple Choice Type. 

                First page would look like this:  Of course this would be piped ….I just indented so you could see what I am talking about.

                               

                Hide question

                                Question by question

                                All in one

Group by group

 

                Show question

                                Question by question

                                All in one

Group by group

 

                Piping

                                Question by question

                                All in one

Group by group

 

                With exclusion

                                Question by question

                                All in one

Group by group

 

                Etc…

                                Question by question

                                All in one

Group by group

 

                                               

                With answer Images

                                Without checkboxes

                                With hover highlight around images

                               

                Click and Go

 

I just want to see if everyone thinks this would be useful….if so …I would like to start this up.  It will take me forever and of course I would work on it in my spare time…but I think it would cut peoples searching and learning time in half.

 

Any comments would be greatly appreciated.

 

Ciao for now,

Marilyn

 

 

 


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and
threat landscape has changed and how IT managers can respond. Discussions
will include endpoint security, mobile security and the latest in malware
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
limesurvey-developers mailing list
limesurvey-developers@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/limesurvey-developers