http://www.perlmonks.org?node_id=17341

As you all know some questions get asked here over and over again. I and I'm guessing most of you would rather code than write up documentation. So instead of forcing the same questions to be asked over and over again in the chatterbox we are now going to allow certain high-level users to create site faq-lets once and add them to a central location. That way questions can be answered once and only once saving all of us a lot of work.

The central location will be Perl Monks FAQ... I still need to code up a bit of functionality but if you want to be added to the group of users who are allowed to add these faq-lets let me know.... For starters to keep things manageable I'm going to limit the users who can add faq-lets to users at level 5 or above. If you meet that criterion and want to help /msg me.

Update: The functionality should all be there now. If you want you can check out the current members of the Site Documentation Clan and if you're above level 4 let me know if you'd like to join our ranks.

If you're a member of the clan all you need to do is go to the section you want to add a faqlet to. Click the link to do so, and then writeup your text. The ownership is then transferred to the clan so all in it can update it as necessary.

vroom | Tim Vroom | vroom@cs.hope.edu

Replies are listed 'Best First'.
RE: Perl Monks Documentation Project
by mdillon (Priest) on Jun 11, 2000 at 21:31 UTC
    perhaps we should add a link the the FAQ section somewhere besides this announcement node. having it in a nodelet should work since those who would benefit most from the section probably don't have their nodelets turned off. however, maybe up to with the other links is the best place.
[reply]
      I would go even further and sprinkle FAQ links liberally throughout the site. There's an awful lot of fine print on every perl monks page, so just one link is going to get lost in the noise. You might even be able to save some space by using it liberally in combination with question marks...for example, instead of Chatterbox...How do I use this?, you could just print the nodelet title as Chatterbox? and leave out the How do I use this? hint. The question mark notation is self-explanatory/unobtrusive enough that vroom could use it many places on the site and have it link either to the general FAQ or specific faqlet areas.

      I think the single most useful spot for it would be above the SOPW question box as "Add Your Question?"

      e-mail neshura

[reply]
        this is a good idea. it would be nice to be able to make these FAQ links with a shortcut like: [FAQ:17393] => ?
[reply]
RE: Perl Monks Documentation Project
by Corion (Patriarch) on Jun 09, 2000 at 23:30 UTC

    Rock on, vroom !

    A small warning I've heard of vroom - there will be concurrency issues... So the Clan members should be somewhat coordinated in their attempts of changing stuff - take a look in the chatterbox, compare it with the clan members list and post a message into the chatterbox before updating an item.

    vroom is still thinking about how new faqlets will be announced to the clan members for review.

[reply]

Back to Perl Monks Discussion