Beefy Boxes and Bandwidth Generously Provided by pair Networks
good chemistry is complicated,
and a little bit messy -LW

Beginning of some quality documentation... hopefully

by vroom (His Eminence)
on Nov 07, 2000 at 21:53 UTC ( #40370=monkdiscuss: print w/replies, xml ) Need Help??

I'm working on improving the site's documentation in general. I started with Chatterbox functionality today. It's viewable at Chatterbox FAQ let me know how it looks and if I've forgotten anything. Hopefully more documentation for the rest of the site will start trickling down as well and we can consolidate it all into one Site Documentation Area.

vroom | Tim Vroom |
  • Comment on Beginning of some quality documentation... hopefully

Replies are listed 'Best First'.
(Ovid) RE: Beginning of some quality documentation... hopefully
by Ovid (Cardinal) on Nov 07, 2000 at 22:07 UTC
    I like this. Lamentably, some of the documentation for this site is either not up-to-date, or squirreled away in some non-inuitive corner. It will be nice to have a central repository of good docs.

    Incidentally, you appear to have mis-worded the first part of the explanation regarding using /msg and /tell.

    For that, you can use the Chatterbox's "private chat" feature. To send a private note to someone, type "/msg" (or "/tell"), add a space, and then type what you want to say.
    In a later example, you show how to use this correctly, but this explanation should mention that the victim's user name should appear immediately after the space that follows the /msg or /tell.

    Yeah, I know, "Who would be stupid enough to not figure that out?"

    Answer: what if dubyah wanted to learn $^X?


    Join the Perlmonks Setiathome Group or just go the the link and check out our stats.

      Wow, what an improvement over the old FAQ which, every time I reread it, led me to use the Chatterbox incorrectly.

      I suppose it's probably a little late for this, but the interface seems a little inconsistent, and I'm a big fan of consistency even if I'm terrible about keeping it. ;^)

      For instance, it might be nice if the documented interface ran something like:

      • [user:vroom] for user links
      • [node:979] for nodes
      • [cpan:Parser::XML] for cpan

      This is just off-the-cuff you understand, but something like that would certainly be easier for me to remember/use in a day-to-day context.

RE (tilly) 1: Beginning of some quality documentation... hopefully
by tilly (Archbishop) on Nov 08, 2000 at 06:26 UTC
    Seriously, take another look at the wiki suggestion I made in RE (tilly) 1: Upcoming survey to help me better the site. Consider creating a documentation wiki parallel to the Everything site. At key points replace documentation pages on this site with what got created on the wiki. That way you can pass the hard work of saying how things work to the users of the site, who as a group can probably do a far better job of polishing than you have energy for.
RE: Beginning of some quality documentation... hopefully
by Adam (Vicar) on Nov 07, 2000 at 22:08 UTC
      It may not differ at all, but Ive never even stumbled across it.

      Ive never used any other link than 'How do i use this ?' to find out about chatterbox functionality, and thats brief to say the least.

      If its not easily locatable from the homepage, without searching, it may be helpful, but its not much use......

(redmist) RE: Beginning of some quality documentation... hopefully
by redmist (Deacon) on Nov 08, 2000 at 03:16 UTC
    I don't mean to be uptight or anything, but in the question:

    "Q: How do I make my code like nice? or why are my []'s getting foobared?"

    "foobar" should be "fubar'd" because it is an acronym for "Fucked Up Beyond All Repair".

RE: Beginning of some quality documentation... hopefully
by extremely (Priest) on Nov 08, 2000 at 08:35 UTC
    Nice! And it teaches new users what the zero node is =)

    $you = new YOU;
    honk() if $you->love(perl)

RE: Beginning of some quality documentation... hopefully
by ZZamboni (Curate) on Nov 11, 2000 at 01:33 UTC

Log In?

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: monkdiscuss [id://40370]
Approved by root
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others chilling in the Monastery: (5)
As of 2023-09-28 10:16 GMT
Find Nodes?
    Voting Booth?

    No recent polls found