[MUD-Dev] Importance of User Documentation

[Jon Morrow]

>-----Original Message-----
>From: mud-dev-admin at kanga.nu [mailto:mud-dev-admin at kanga.nu]On Behalf Of
>Sanvean
>Sent: Saturday, September 30, 2000 3:38 PM
>To: mud-dev at kanga.nu
>Subject: Re: [MUD-Dev] Importance of User Documentation

>a) Tried to make the help files follow the same syntax, as well as
>providing some that list related helpfiles, such as all the communication
>related, all the combat related, etc. as well as a top40 helpfile that
>lists the 40 helpfiles people really should know before starting to play,
>etc.  We've also made the see alsos as the bottom as consistent and
>thorough as possible.  Some help files are only accessible to a particular
>group -- all the psi and spell helpfiles are available only if you have
>that particular skill, for example.

This is a wonderful system as long as it is consistent.  Below you mentioned
that you have walk-throughs on your WebSite.  What thought have you given to
putting guided and interactive tutorials in Armageddon?

>b) Written a script that, when someone requests a helpfile that isn't
>there, writes the requested word to file, so I can go and look to see if
>there's anything popping up consitently that needs a helpfile.  (This
>occasionally leads to fun results, such as noticing that someone has typed
>help hyperspace, or help I_wonder_if_they_really_do_look_at_these).  I
>can't claim credit for this excellent idea, since I ran across it on a
>mudsnippets page whose location I have, alas, forgotten.

Beautiful!  I'm sure your project has benefited greatly from the script and
I praise you for your dedication in continuously updating.

>c) Provided a way to access all the helpfiles through the webpage.

Are they accessed very often on the web page?  What were your motivations
for doing so?

>d) Provided EXTENSIVE documentation on the webpage, including walkthroughs
>and guides written by players.  There's also specialized clan
>documentation, which includes things like the history of the clans, names
>and backgrounds on clan NPCs, various guidelines for different clan roles,
>like guards or merchants, etc.  Recently, I tried providing something like
>a slideshow for players, intended to get those resistent to wading through
>the documentation, to get a feel for the game (which I'm rather pleased
>with, so far, located at http://ginka.armageddon.org/slides/intro1.html).

Supplementary material is always a great idea.  I like the slides.  What
kind of response have you gotten from them?

Regards,

Jon




_______________________________________________
MUD-Dev mailing list
MUD-Dev at kanga.nu
https://www.kanga.nu/lists/listinfo/mud-dev