[xwiki-devs] [Proposal] New FAQ Application and new FAQ strategy
Hi devs, I've created a new FAQ application. It's currently available from http://www.xwiki.org/xwiki/bin/view/FAQ/WebHomeNew (it's linked from the old one: http://www.xwiki.org/xwiki/bin/view/FAQ/WebHome) The reason I rewrote it is because I think FAQs are important and that we're not using it enough Here's how I think it could work out: * If a user has a question he/she should verify if it's already in the FAQ. If not then he/she should post a message for the XWiki Mailing List/Forum. * The strategy is then for people who know the answer to create a new FAQ entry about the question and reply in the mail with the link to the new FAQ Entry In this manner we will quickly enrich this FAQ database. Of course the FAQ answers should be as short as possible and point to existing docs (if those docs don't exist they should be updated/created). Basically I see FAQ as entry points to our documentation, from the point of view of someone asking questions of the type "how do I….". Thus there can be several FAQ entries all having the same link to the documentation. WDYT? Thanks -Vincent PS: As you can see I have only 4 entries right now since we need to migrate exisitng FAQ entries: - use a good page name - rewrite them in XWiki Syntax 2.0 - verify their accuracy - update docs where needed Maybe we should have a FAQ day to work on that?
On Fri, Oct 28, 2011 at 16:46, Vincent Massol <vincent@massol.net> wrote:
Hi devs,
I've created a new FAQ application. It's currently available from http://www.xwiki.org/xwiki/bin/view/FAQ/WebHomeNew (it's linked from the old one: http://www.xwiki.org/xwiki/bin/view/FAQ/WebHome)
Does it use the new ApplicationInMinutes framework ? probably not. Dommage.
The reason I rewrote it is because I think FAQs are important and that we're not using it enough
Here's how I think it could work out: * If a user has a question he/she should verify if it's already in the FAQ. If not then he/she should post a message for the XWiki Mailing List/Forum. * The strategy is then for people who know the answer to create a new FAQ entry about the question and reply in the mail with the link to the new FAQ Entry In this manner we will quickly enrich this FAQ database.
Of course the FAQ answers should be as short as possible and point to existing docs (if those docs don't exist they should be updated/created).
Basically I see FAQ as entry points to our documentation, from the point of view of someone asking questions of the type "how do I….".
Thus there can be several FAQ entries all having the same link to the documentation.
Globally, it is a good way to go, but I dislike links that do not precisely respond to the question. I have checked one of them earlier today, and I was not sure what was really the answer. So it would be better to have a small answer and a link for more detail IMO.
WDYT?
Thanks -Vincent
PS: As you can see I have only 4 entries right now since we need to migrate exisitng FAQ entries: - use a good page name - rewrite them in XWiki Syntax 2.0 - verify their accuracy - update docs where needed
Maybe we should have a FAQ day to work on that?
_______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
-- Denis Gervalle SOFTEC sa - CEO eGuilde sarl - CTO
On Oct 28, 2011, at 5:36 PM, Denis Gervalle wrote:
On Fri, Oct 28, 2011 at 16:46, Vincent Massol <vincent@massol.net> wrote:
Hi devs,
I've created a new FAQ application. It's currently available from http://www.xwiki.org/xwiki/bin/view/FAQ/WebHomeNew (it's linked from the old one: http://www.xwiki.org/xwiki/bin/view/FAQ/WebHome)
Does it use the new ApplicationInMinutes framework ? probably not. Dommage.
xwiki.org is currently on 3.1 (old sheet system).
The reason I rewrote it is because I think FAQs are important and that we're not using it enough
Here's how I think it could work out: * If a user has a question he/she should verify if it's already in the FAQ. If not then he/she should post a message for the XWiki Mailing List/Forum. * The strategy is then for people who know the answer to create a new FAQ entry about the question and reply in the mail with the link to the new FAQ Entry In this manner we will quickly enrich this FAQ database.
Of course the FAQ answers should be as short as possible and point to existing docs (if those docs don't exist they should be updated/created).
Basically I see FAQ as entry points to our documentation, from the point of view of someone asking questions of the type "how do I….".
Thus there can be several FAQ entries all having the same link to the documentation.
Globally, it is a good way to go, but I dislike links that do not precisely respond to the question. I have checked one of them earlier today, and I was not sure what was really the answer. So it would be better to have a small answer and a link for more detail IMO.
Yes a small text to put things in context is good. Thanks -Vincent
WDYT?
Thanks -Vincent
PS: As you can see I have only 4 entries right now since we need to migrate exisitng FAQ entries: - use a good page name - rewrite them in XWiki Syntax 2.0 - verify their accuracy - update docs where needed
Maybe we should have a FAQ day to work on that?
Hi, +1 I'll be happy to help move the pages. Silvia On Fri, Oct 28, 2011 at 5:46 PM, Vincent Massol <vincent@massol.net> wrote:
Hi devs,
I've created a new FAQ application. It's currently available from http://www.xwiki.org/xwiki/bin/view/FAQ/WebHomeNew (it's linked from the old one: http://www.xwiki.org/xwiki/bin/view/FAQ/WebHome)
The reason I rewrote it is because I think FAQs are important and that we're not using it enough
Here's how I think it could work out: * If a user has a question he/she should verify if it's already in the FAQ. If not then he/she should post a message for the XWiki Mailing List/Forum. * The strategy is then for people who know the answer to create a new FAQ entry about the question and reply in the mail with the link to the new FAQ Entry In this manner we will quickly enrich this FAQ database.
Of course the FAQ answers should be as short as possible and point to existing docs (if those docs don't exist they should be updated/created).
Basically I see FAQ as entry points to our documentation, from the point of view of someone asking questions of the type "how do I….".
Thus there can be several FAQ entries all having the same link to the documentation.
WDYT?
Thanks -Vincent
PS: As you can see I have only 4 entries right now since we need to migrate exisitng FAQ entries: - use a good page name - rewrite them in XWiki Syntax 2.0 - verify their accuracy - update docs where needed
Maybe we should have a FAQ day to work on that?
_______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
participants (3)
-
Denis Gervalle -
Silvia Rusu -
Vincent Massol