Should Moodle.org forums have a FAQ section?

Should Moodle.org forums have a FAQ section?

by Gary Anderson -
Number of replies: 28

Usually it is a good idea to look through a forum for help to your question before making a fresh posting.  But often one finds false starts or advice that is given over and over.  And many of the forums have simply too many threads.

I think that it would be a good idea to have a FAQ section in docs.moodle.org the gives answers to common issues that that are carefully written.  Then then least the FAQ could be a common stating point for any discussion.  The FAQ would still be community generated as it is a wiki.

The header at the top of the forum could be a place for this link, so it would not require a change in the code.

What do others think on this?

--Gary

Average of ratings: -
In reply to Gary Anderson

Re: Should Moodle.org forums have a FAQ section?

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators
Hi Gary,

Thanks for your suggestion of adding links to FAQ pages in forum introductions. approve

I've updated several forums and followed your suggestion, and have created an issue in the tracker - MDLSITE-348 - so that FAQ pages are created and linked to in each Using Moodle forum introduction.
In reply to Helen Foster

Re: Should Moodle.org forums have a FAQ section?

by Ger Tielemans -

It is an old discussion, but reworking the current overcrowded formus to FAQs and start over again with forums...

THe formal Birth of 1.9 could be such moment...

In reply to Ger Tielemans

Re: Should Moodle.org forums have a FAQ section?

by Julian Ridden -
Yes, Yes, Yes.

Anything we can do to try and ease access to vital information the better. Moodledocs is still too confusing for the average punter (or so I am told) and FAQs are a good solution.

As for easing the confusion of finding posts, dont think there will ever be an answer to that since we now have so many active members adding so many new posts.

JR
In reply to Julian Ridden

Re: Should Moodle.org forums have a FAQ section?

by J Rogers -
I agree, there are lots of tidbits of wisdom inside forum discussions that need to be moved to a FAQ.
In reply to J Rogers

Using Moodle forums now have FAQ links

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators
Hi everyone,

To update you, all the main Using Moodle forums now have FAQ links in the forum introductions, and an FAQ index link is included in the footer of each page.

Any time you post in a forum and think "I've answered this question before", please just add it to an FAQ page, then post a link to the FAQ page in the discussion.

Alternatively, if you come across useful or interesting discussions, you can simply add a link to the discussion in the see also section of the FAQ page.

Thanks in advance for everyone's help in adding FAQs! smile
In reply to Gary Anderson

Re: Should Moodle.org forums have a FAQ section?

by John Isner -
Linking to the FAQ index (http://docs.moodle.org/en/Category:FAQ) is an excellent idea, but why link only from the forum introduction, as suggested by MDLSITE-348?

The placement of the link should cater to the important use cases. We have use cases for users who ask questions and users who answer them.

User asks a question: An unsophisticated user may well go to the forum introduction and possibly see the link there. A sophisticated user will be using Google or Site search. If there is an FAQ, the user will find it without using the link.

User answers a question: This user is best served by a link co-located with question itself. The user is unlikely to go to the forum introduction to get the link.

So a link in the forum introduction, while useful, caters to a relatively unimportant use case.

I read 99% of all questions as e-mail. When I decide to answer a question, I click "See this post in context." Ideally, I would like to check the FAQs BEFORE I do this, because I would prefer to answer with a link to a FAQ if one exists (and maybe I'll create it if it doesn't exist). So for me, the best place for the link would be in the FORUM EMAIL.

Show parent | Reply
See this post in context
FAQ index

I know that we can bookmark the FAQ index. But having constant reminders in forum emails would encourage helpful users to grow our FAQ database.
Average of ratings: Useful (1)
In reply to John Isner

Re: Should Moodle.org forums have a FAQ section?

by Martin Dougiamas -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers
Great ideas, we should definitely have FAQ links from everywhere (email, headers, footers). Filed MDLSITE-474 for this.
In reply to Martin Dougiamas

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
Seems to be the same kind of issue has been discussed in half a dozen different threads, including but not limited to this thread
http://moodle.org/mod/forum/discuss.php?d=94833 (which seems not to come up in the design forum) and also prompted this discussion:
http://moodle.org/mod/forum/discuss.php?d=98115

Should all these various suggestions be included in the tracker item created, or should each different idea have its own tracker item so allow for voting, and if the latter, should there be some period identified for persons to post all possible alternatives to the tracker for the purposes of being able to identify them in a forum posting inviting people to vote among them (a la the wiki process??)
In reply to Marc Grober

Re: Should Moodle.org forums have a FAQ section?

by Chris Collman -
I agree Marc, these are topics that appear in various threads (I wonder why blush).

Input from the larger community is always good, even if it is the tip of the iceberg with responses.

FAQs are generally for new users. I was thinking about a questionnaire for new users on moodle.org. Don't real educational places do that kind of thing? Quite honestly, I don't know smile I thought it would be a chance to show off another Moodle feature, rather than shuffle them off site to Tracker.


Best Chris

In reply to Chris Collman

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
That is one reason I suggested that new users be automagically directed to a query engine specifically adapted to find them these newbee solutions.... As I think becomes obvious when looking back over such discussions, the same issues surface month after month and everyone agrees that we need to distill info and make it easy to access, but, there are some hurdles, one being the willingness of folks to actually move material to docs and a second being the willingness of new users to look in the right place first.....

In recent months I have taken to at times change the subject of a posted response because the initial search afforded users seems to search subject lines only..... so a solution published in the forum which a subject line easily found with anticipated search terms should be more effective..... but I was disappointed that though I tested this kind of response based on keywords users used when posting the samo questions, the new users' questions suggested that they had not searched with the same terms they used to ask the forum question....

So..... rather than argue that newbees are lazy toads I suggested a mechanism whereby newbees efforts to post their questions would be first injected into a query mechanism designed to present to them the most likely solution to their problems ( I posted the link to that suggestion earlier in this thread) based upon a dictionary if you will (just a table). I think the look up table and the query code could be easily done (I provided URLs to tools and examples) but it would take a moodle developer I think to be able to integrate the existing forum code with such an engine.... and of course I would suggest that once one has demonstrated that one has some measure of experience there should probably be a way to either turn the search feature off or to provide more advanced users a different interface...........

I think that a FAQ in some respects is really not much more functional than providing this kind of lookup engine (as opposed to perhaps, a HowTo - but that gets into splitting hairs... though I do think that in some respects the moodle docs need to be sensitive to serving up info for different users.... there are users who just need the step by step of how to get from point A to point B, there are those who really need to understand how this or that works, and there are those who need internals etc.

In any event, I think it unreasonable to expect new users to search tracker and I think it unreasonable as well that there are unanswered questions in the forums, not to mention bugs in the code.... LOL the question I think has to be how best the community can serve itself..... and I think the two most immediate demands are that people spend time adding to the docs and that we force posters through the search engine before allowing the post....
In reply to Marc Grober

Re: Should Moodle.org forums have a FAQ section?

by Chris Collman -
Marc,
I enjoyed your post. I had not considered changing the subject line to assist others later.

Personally, I agree with you that the same "issues" are brought up again and again. My theory is that we have similar types of users being dumped into the "new user" bin. The numbers probably follow some predictable amount based upon world wide school years , Moodle's market penetration and faculty turnover. Some users are "lazy", some are just plain ignorant on how to look for anything, and some have concepts that do not seem to match with MoodleSpeak.

Interest concept about injecting a new users question automatically into a query system. Might work to reduce the number of repeated questions.

I considered some sort of flag system for marking selected posts. Not only to gather "data" but to alert potential answerers. My two categories: Newbie questions (for Chris cool), tougher questions (for the real experts).

Again, data would be nice to direct our efforts. Seems like all of us "feel" but can not quantify. It could be we are collectively doing a great job. After all, new learners are always going to have questions.

Best Chris






In reply to Chris Collman

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
Just for one I suggest anyone who wants to experience newbie frustration use the initial search feature to look for a posting s/he has made recently. What becomes immediately obvious is that the existing simple search is more likely to confuse than enlighten. Re titling posts that have solutions helps, but the user still has to search, and threads can have dozens and dozens of posts, many that would just totally confuse users.

Hence my suggestion to essentially automate the search by making it part of the posting process. A user begins typing in their post and up pops a window that parses through their post, searches the dictionary and pops up suggestions as to where the user will find their answer. And of course there is a little obligatory check box that indicates that the user has reviewed the suggestions BEFORE completing their post..... Here is the URL to the post in that thread (http://moodle.org/mod/forum/discuss.php?d=98115&parent=434158 ) and here is an excerpt, citing just one of a number of solutions (this uses php and ajax) to effect this live search:

I have come across some php/ajax that does a live
search based on an xml dictionary
http://www.w3schools.com/php/php_ajax_livesearch.asp that is I think more along the lines Todd is
thinking than the KISS type option I was initially
suggesting. There are also similar resources for doing the same kind of thing in js.
In place already is a rating system (and I won't rehash here the recnt discussion of the possible flaws in that) and a PHM group (ditto) and the same dozen questions continue to be posted. Another suggestion from the other thread cited was sticky posts in forums, which are essentially comparable to FAQs. Of course, there are those who weighed in that the docs are there to serve that purpose.... One has to ask, why publish a separate FAQ, which will inevitably result in an inconsistency with the docs, as opposed to putting adequate tags in the docs and pointing people to comprehensive docs with perhaps howto sections. I think the secret to making things workable is keeping them simple, and adding a FAQ doc actually makes the doc mechnism more, not less complex. In other words, why not spend the time making the docs better, as opposed to creating another iteration of the docs.....

I think we are better off building the data directory to help search the amazing breadth of information on the moodle, then building more places to hide possible inconsistent info.....

However, my idea resulted in only one rating of useful (I am saying this a bit tongue in cheek you understand). We have hordes of trackers items that sit lonely and abandoned ...... While there may be those who want to see this kind of active lookup accomplished, at least I haven't been convinced that there is enough support to push this in tracker.....

Lastly, I think you are correct about need for data and jargon. I made some suggestions as to how I think pertinent data could be used, but I did not see a lot of encouragement there. As to users, we see quite a few people saying, "I have absolutely no idea about how to manage any OS but I want to run Moodle, so how do I do it....." and for these folks what are you going to do? I think this is in part a response to a broadly accepted concept that anyone can do this "web stuff", and if a 3rd Grader can't do it, it is garbage (this last bit a poor paraphrase of someone posting about the paypal module). One suggestion is that Moodle provide a moodle course that one must pass before being able to install, post or what have you.... I don't know if this is a good idea or not (I think, based on my own experience as a user and teacher that academic laziness is one facet of the passivity I think I see growing in U.S. "culture", and that lowering expectations has a very clearly foreseeable conclusion.....)

On the otherhand, for those of us who maybe can do (or at least acknowledge that something should be done) how do we proceed?

Whoops..... sorry, I promised to try and stay off the soap box (at least I was going to tag rants.... the best laid plans and all that......
In reply to Marc Grober

Re: Should Moodle.org forums have a FAQ section?

by John Isner -
I think FAQs should be viewed as something that benefits question answerers, rather than question askers, at least initially. For now, I suggest that we forget about the askers and put our creative energies into helping answerers. I'm getting tired of answering the same questions over and over, aren't you? I even find myself skipping questions that I know I could answer, because I'm tired of repeating the same explanation. If I could answer 50% of all questions with "See this FAQ," I could double the number of questions I answered. If we all did this, we would eventually have a very large database of FAQs, and this database would BEGIN to be useful to question askers.

I agree that inconsistencies can be a problem. That's why I suggested making a FAQ a short, high-level synopsis that points to information elsewhere (as in the example I gave).

The nice thing about a FAQ is that you can edit it, which is exactly what's wrong with forum posts. The forums are full of inconsistencies that unfortunately can never be unsaid. FAQs solve this problem by introducing a level of indirection.

Incidentally, docs.moodle.org has a total of 169 FAQs in 17 categories (that's all??) The winner is Installation with 33 and the runner up is Administration with 24. I have personally written only two. I think that's an embarassingly small number.

The real question is not why question askers don't read FAQs. It's why we, the question answerers, don't write them. I could suggest several posible reasons, but not in a forum open to Google smile


In reply to John Isner

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
John I couldn't agree with you more, which is why I think building a data directory (which I think is really what you are arguing, though the product you advocate would be accessible directly, as opposed to being implemented through something like livesearch) is perhaps a more economical way to get there. The problem I think is that the FAQ will not be as you envision it, and I offer the comment below to evidence that argument, and NOT as any criticism of the material offered in the FAQ....

If the proposed FAQ is to be "a short, high-level synopsis that points to information elsewhere" then it is critical for that information to be elsewhere.... and that brings me to a different question than you pose; not why aren't we writing FAQs but why aren't we writing docs.

BY way of example, while the recommendations provided here: http://docs.moodle.org/en/Backup_FAQ#How_do_I_backup_my_whole_Moodle_site.3F
cd /my/backup/directory
mv moodle-database.sql.gz moodle-database-old.sql.gz
mysqldump -h example.com -u myusername --password=mypassword -C -Q -e --create-options mydatabasename > moodle-database.sql
gzip moodle-database.sql
are well intentioned, they would totally confuse many who have been posting (why do I get an error that the file moodle-database.sql.gz doesn't exist?) while the recommendation provides some suggestions about using rsync could be confusing (the directions talk about using another host only, though the examples include copying to a local host) and fail to explain the differences between copying the file structure and tarring or zipping the files.... Moreover, there is no suggestion that the moodle program files be backed up, and as I have noted before, this can present a nightmare (e. g. you are running 1.8.2, you back up moodledata and db, lose the site, try to pull 1.8 from the cvs and you end up with things broken because something working under 1.8.2 is now not working under 1.8.4, and now instead of a quick restore you have to figure out what is clashing with 1.8.4 while you have no moodle in production....)

Better to explain that a user might benefit from creating a third directory (moodle root, moodledata, and then moodlebackup) and then actually provide a script with explanations that backs up db, backs of moodledata, backs up moodle (any of the three depending on args) and then provides an rsync option? I am not suggesting that the contribution is not valuable; it certainly is. But I certainly would not want many of the newbees we see posting looking at that as I think it would generate more problems in certain populations than it would resolve.....

The same would apply for example to developing a set of scripts that would automate upgrades from CVS after doing a complete save..... I would not want to put bits and pieces into a supposedly high level doc for fear of the the possible disasters it might precipitate, while putting such stuff in developer pages as part a developing set of advanced management scripting would certainly be appropriate....

I guess what I mean is that the FAQ needs to be appropriately targeted, and it looks to me like some of the FAQs seem to be replacing the docs they should be referencing...... and exposing those already overwhelmed to material they are simply not equipped to deal with....
In reply to Marc Grober

Re: Should Moodle.org forums have a FAQ section?

by John Isner -
Marc,
If the proposed FAQ is to be "a short, high-level synopsis that points to information elsewhere" then it is critical for that information to be elsewhere....


Yes!

I guess what I mean is that the FAQ needs to be appropriately targeted, and it looks to me like some of the FAQs seem to be replacing the docs they should be referencing...... and exposing those already overwhelmed to material they are simply not equipped to deal with....

Yes! Articles like Backup FAQ should be refactored into article + FAQ. There are clearly some legitimate FAQ's lurking in the Backup FAQ, but mostly it is an article with headings written in the form of questions. Any article can be written that way, but that doesn't make it a FAQ.

that brings me to a different question than you pose; not why aren't we writing FAQs but why aren't we writing docs.

What's your theory? Tell me yours and maybe I'll tell you mine.
In reply to John Isner

Re: Should Moodle.org forums have a FAQ section?

by A. T. Wyatt -
Hi, John!
I will tell you mine! I am reluctant to write anything because I am concerned about contributing text that will become outdated with the next version, but still might be helpful for people with older versions. I have wished there was a better/more clear way to separate out 1.5, 1.6, 1.7-8, 1.9, and now 2.0 because there are really some very big differences between them.

I also still feel uncomfortable with media wiki format (especially putting in screen shots).

I wish media wiki was single-sign on with moodle, so I could go right there when I find something. It is a little thing, but does require another effort (which might be necessary, but once you HAVE a login over there, it would be lovely for it to be recognized).

I wonder if we should have some "high level" pages, as you describe (just the facts ma'am) and then link to the pedagogical and then technical backgrounds. How do you make sure all people have AND CAN FIND what they need? This is probably in my field, so maybe I will see what I can turn up in the library. . .

So I will say that I should do better also, so if you figure it out first, let me know and I will try to help! smile

atw
In reply to A. T. Wyatt

Re: Should Moodle.org forums have a FAQ section?

by John Isner -
This discussion reminds me of a blog post I read recently. It was written by a fellow techno-pessimist. He tells about a talk he had given at a conference on how the iPhone and Google are making us stupid. Tellingly, nearly all the questions that followed had to do with how the attendees could get their Internet service to work more cheaply and smoothly.
In reply to John Isner

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
Tellingly, nearly all the questions that followed had to do with how the attendees could get their Internet service to work more cheaply and smoothly.

Any good tips? wink

I am afraid that at least in the U.S. we have been trained to be passive, pitiful and pathetic.... There is no way we will ever have universal health care, a well informed electorate, a healthy educational system..... yahoos indeed.

In reply to A. T. Wyatt

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
Sounds like we need a new thread..... "top ten reasons for not adding to moodles docs....." I wonder how the various responses to such a thread my be rated ;=}

But I digress....

Yes I agree with you about the version diffs and I think that needs to be addressed structurally.... I have tried to highlight potential for problems in anything I have fiddled, but it ends up looking a bit twisted and recent posts regarding some of the pages suggest that it doesn't take much to confuse (though perhaps I am just good at it......)

I also agree about mediawiki.... I prefer dekiwiki, but no matter what the target, there will be issues so I don't know if there will ever be a comprehensive solution in that respect.

For myself, I have to say that I was a bit apprehensive about jumping in and rewriting something that someone else had written.... It takes time to fully research a question, draft text, have someone point out that the text leaves too much to be desired and rework it, and then add the 11 exceptions....

Additionally, it does take time to add to docs, and if one is responding to forum questions there is the question of balancing the demands for the limited time one may have to spend here (except for John, who apparently has no other life....) Since being a PHM seems to be a role coveted by some, perhaps making improvements to docs of no less than 74 words per month should be an ongoing requirement as an incentive? Seriously though, I think if the docs are more robust and we had a livesearch forum post code, a reduction in questions would possibly be seen as incentive to build docs?

OK John, we showed you ours.... now you show us yours.....


In reply to Marc Grober

Re: Should Moodle.org forums have a FAQ section?

by John Isner -
Sounds like we need a new thread "top ten reasons for not adding to moodles docs"

Better: My reasons for not adding to moodle docs. No one is interested in hearing ME speculate about why OTHERS don't contribute. It would be yet another exercise in phony collective self criticism.

Technical difficulty of dealing with Mediawiki is one of my reasons, but not a major one.

Another reason (still not major) is dealing with the current organization. Whenever I am tempted to add or change something in docs, I feel that I need to do some preliminary reorganization, since what I want to say doesn't fit perfectly anywhere. Maybe an existing article needs to be refactored (our friend the Backup FAQ), or a new category created and an article moved. Writing good documentation is no different from writing good code. You have to constantly refactor it to prevent entropy, and it is too much work, even for a person with no other life.

For myself, I have to say that I was a bit apprehensive about jumping in and rewriting something that someone else had written

The keyword is rewriting. I'm not apprehensive about adding or tweaking, but I am apprehensive about rewriting. So the documentation expands when it should shrink. For example, I have often looked in dismay at the Roles article. Should I rewrite it? Hmm, I'm a bit apprehensive: What will the authors think? Should I try to fix it by tweaking? Hmm, too much work. Should I add a redundant article and just call it something else? Entropy.

But my main reason is the converse of your last reason:

For myself, I have to say that I am a bit annoyed when someone else jumps in and rewrites something I have written

...or alters the meaning, especially in matters of taste or opinion. Please don't replace my opinion with your opinion. But wait, it's a wiki and we're social constructionists, so I am clearly too sensitive.

Take a look at Gary Anderson's Gradebook 1.9 tutorial. He signed it. I like that! Now look at the history. A couple of people fixed typos, but no one altered his meaning. If someone wanted to change Gary's meaning, I'm sure they would have contacted Gary privately, rather than just doing it. Signing it creates an implicit protocol for changes.

By the way, I have begged you (Marc) to rewrite the DragMath article, so I hope you don't think it is the issue here.

Better/faster/cheaper technology will not solve my problem.
In reply to John Isner

Re: Should Moodle.org forums have a FAQ section?

by Marc Grober -
Once again John you have demonstrated why you must have been a whackamole champ (nail on the head and all that)!

Some additional thoughts:

I had not thought about signing docs in that the history function of the wiki provides that info and I always look at the history before wading in. I do like what you have done with the perms calc (i.e. just adding a new page) and anyone looking at the History of that page would be made instantly aware of who is responsible for its content.

What one sees in wikipedia I think is instructive. I see three basic behaviors: all or nothing (I completely undo what you have done and then you come back and undo what I have done and the page gets locked), there is discussion in the Talk page looking for consensus and participants attempt to find consensus, there is a recognition of multiple valuable responses to an issue and the structure changes to address that. The most constructive tack can be prior discussion, but if those with an interest refuse to engage in discussion (and I have seen such behavior in Moodle) we get into an all or nothing game.

I agree that structure can be really problematic. I ran into that with ssh, eclipse and the Math page. I do think use of the Page Comment feature would be useful but have been disappointed in what I have not found there.... Would a discussion here (http://docs.moodle.org/en/index.php?title=Talk:Roles_and_capabilities&action=history) prior to your work have been of any value?

I am still a bit confused on Development: versus Developer as in "are these pages under Development or are these pages docs for Developers...." See, e.g., http://docs.moodle.org/en/Developer_documentation

As far as DragMath, no sweat! Keep the pressure on ;=} However, I have made some major changes to the page over the few months and have some further plans: http://docs.moodle.org/en/Talk:DragMath_equation_editor
In reply to Gary Anderson

Re: Should Moodle.org forums have a FAQ section?

by Chris Collman -
Hi,
There are several things which Moodle could consider to improve the learning curve for adult learners. We know "one size fits all" is not one of them smile We need to encourage people to use existing tools and provide more variety in our examples.

I would like to see more FAQs pages in MoodleDocs but why (not how) are people going to find them? People who post answers in forums usually do not bother to point to a reference in MoodleDocs. Yes, I would like to see people who answer questions, especially FAQs in forums to ALWAYS provide links to existing documentation, it is as important as a positive rating. Last week I gently asked a new Moodler where they looked prior to posting. Much to my surprise they referenced two separate pages in Jason and Helen's Moodle book but had not looked at MoodleDocs. Why? I think it was all about the home page of moodle.org . The why has to do with marketing and presentation.

Do we have any data on how often new users in moodle.org access docs.moodle.org in say the first 3 weeks? Do we have a questionnaire for new users on moodle.org to start gathering specific comments from new users on their learning curve with ? This is important stuff.

We need more examples. I hear the comments that it is hard to find things in MoodleDocs for a new Moodler. To me that speaks of over views, language, links and expectations that everybody uses Moodle they way they want to. How can we steer people to easier ways of acquiring knowledge?
  • I don't think we have a successful (one that has been replicated several times) format for providing course or site examples.
  • demo.moodle.org is stale and stuck back in 1.5 for all intents and purposes.
  • examples.moodle.org that is similar to demo.moodle but where "simple approved courses" are put up as examples for people to play with. Not a full blown Physics 101 but the flavor.
  • Name space of examples in MoodleDocs where people can read a dialog about a physic's course, a poetry course, that has link from it to sections in MoodleDocs.

Creating examples for training purposes is a lot of work and I sometimes wonder if creating code is easier smile I do think that there have been many positive changes in presenting Moodle to new users. Maintaining them is the hard part.

Best to all Chris






In reply to Chris Collman

Re: Should Moodle.org forums have a FAQ section?

by John Isner -
Chris Collman writes:

I would like to see more FAQs pages in MoodleDocs but why (not how) are people going to find them?

I will certainly begin using the http://docs.moodle.org/en/Category:FAQ link, now that I have been reminded of it. If I read a question and I know (or suspect) that it is a is a frequently asked one, I can go to the Category:FAQ page and find out quickly if it has already been answered. If it has, I can copy link location and paste into the forum reply. If not, I can create the article first.

I would like to see people who answer questions, especially FAQs in forums to ALWAYS provide links to existing documentation

If it is a frequently asked questions, the person answering the question should link to a FAQ in docs (creating one if necessary), rather than linking to a general article. The FAQ answer should be short; if necessary, it can link to general articles and forum discussions. At least this is the way I have done it. For example, see What is my role here? If I had responded with a link to the article, I don't think anyone would have read it (I know I wouldn't smile ).

If you check the Category:FAQ page, you will see there are only 17 articles. Why so few? It may be because not everybody (including me!) may not be completely confident about how to create a FAQ article. I have never created one. I have only added new questions to existing FAQ articles.

Maybe Helen or some other knowledgable person can say if this is the right way to do it. In the article on Foo, you can have a link like

See the Foo FAQ

This creates an article called Foo_FAQ. The article itself looks like this:

{{FAQ}}
==blah blah blah?==
answer
==blah blah blah blah?==
answer
==blah blah blah blah blah?==
answer

Am I missing anything? It would be good to have step-by-step instructions in http://docs.moodle.org/en/Help:Editing




In reply to John Isner

Re: Should Moodle.org forums have a FAQ section?

by Séverin TERRIER -
Picture of Documentation writers Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators
Hi John,

what you think to add a FAQ is the good way to do it smile

Just adding {{FAQ}} at the beginning will automagically push the article in the FAQ category : http://docs.moodle.org/en/Category:FAQ

After that, you can edit the page like any other one smile
Séverin
In reply to Gary Anderson

Re: Should Moodle.org forums have a FAQ section?

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators
A big THANK YOU to everyone for your comments and suggestions! approve

Apologies for not replying till now (I'm supposed to be on holiday at the moment wink). As soon as I have chance though, I'm going to carefully read through every post and try and make the most of all the great ideas!