Hi Marylin,

this all sounds great, please find some clarifying comments below...

Am 15.05.2012 17:03, schrieb Marilyn Banister:

Hi,

Being that I am so new to LS, I am sure there are many things that could have sped up my learning process….I just had a heck of a time finding them. 

 

I am so new here so not sure of all the existing docs…Toms examples are great and right in line with what I am talking about…just it’s title was under wording that a person who can barely code wouldn’t get to fast (smile).

 

I think calling it an “question example and roadmap” or something like that would work.

 

I want to make sure I understand what you and Tom are talking about.  For example:

5 separate surveys:

                Array

                Multiple Choice

                Single Choice

                Mask Questions

                Text Questions

-> Looks good. I'm no native english speaker and I have always wondered about the term "mask questions", but if this sounds fine to you, we just take this term and/or maybe add something like (date/ranking/...).

 

In those surveys have examples with the links to documentation in the help area and in the documentation have the link to the specific survey.  Hope I got that right (smile).

-> Exactly! I think for some tricky examples we should also add some notes at the survey help section to point users to things they have to watch out for.

 

I also think adding them so users can check the features live before downloading LS is an awesome idea.

-> survey.limesurvey.org will be updated to the latest 1.92 version soon and I will then create an account for you so you can add the surveys there and we can link them at the manual.

 

I don’t mind doing this. Just a few things to consider…..  Due to my inexperience with what already exists, what is to come, etc.  I will need some guidance on what examples you want in each survey.  If you could create me an outline that would be great.

-> I suggest to start with the complex features and question attributes first. You as a rather new Limesurvey user should now best what is complicated. For me it is a little hard to help here because I use the software for years.

 

I would also probably come up with a few bumps as far as coding goes i.e. piping…haven’t done that yet (smile).

-> Please create a thread at the forums where you can then ask questions (send the link on this list so we can monitor and help where necessary). This might also be a good opportunity to get in touch with other users and ask what features they are interested in.

 

Let’s do a sample one and take it from there….So if you have the time to point me in the direction you would like to go….I am willing to give it a shot.

-> So let's start with the "Array" question. There are aleady some quite complex features like "random answer order", "use dropdowns" and min./max answers.

If you need any help, you can always try to ping me (User "Mazi") at the Limesurvey chat: http://www.limesurvey.org/en/community-services/live-chat

Best regards,
Marcel

 

Ciao for now,

M                           

                               

 

 

From: Marcel Minke (Limesurvey) [mailto:marcel.minke@limesurvey.org]
Sent: Tuesday, May 15, 2012 10:10 AM
To: limesurvey-developers@lists.sourceforge.net
Subject: Re: [limesurvey-developers] Documentation idea

 

Hi Marylin,

I totally agree that a demo is worth more than a thousand words, so this is a great idea.

As Tom has noted, I wouldn't create an extra survey for each survey mode and for some features, you'd have to combine question types. To follow the documentation order, I also agree to create a single survey for each question type which contains several questions, each demonstrating a certain feature. To minimize the work that needs to be done, I also wouldn't create a single question for each question type - question attribute combination, because e.g. a "prefix" works the same at different question types and we can also combine some question attribute demonstrations. Furthermore, for some features, Tom has already created great examples at http://docs.limesurvey.org/Expression+Manager+Sample+Surveys&structure=English+Instructions+for+LimeSurvey&no_bl=y

To me the most important feature is to link from the survey to the documentation and vice versa. I also think that adding all surveys for download AND adding them at survey.limesurvey.org so users can check the feature live without having to install Limesurvey is a huge benefit. I can create an account for you for survey.limesurvey.org so you can create those surveys there. What do you think?

Another idea for improving the documentation is to add a "you might also be interested in these pages" (list of links) and or sentence like "Know that you know how to deal with X, you can continue to do Y (link) or Z (link).
What do you think?

Thanks for helping us improving the documentation!

Best regards,
Marcel

Am 15.05.2012 14:12, schrieb Marilyn Banister:

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
  
------------------------------------------------------------------------------ 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