User Name:


Forgot your password?
Vote for Us!
6Dragons ogg Soundpack
Author: Vladaar
Submitted by: Vladaar
6Dragons 4.4
Author: Vladaar
Submitted by: Vladaar
LoP 1.46
Author: Remcon
Submitted by: Remcon
LOP 1.45
Author: Remcon
Submitted by: Remcon
LOP Heroes Edition
Author: Vladaar
Submitted by: Vladaar
Users Online
CommonCrawl, DotBot, Vladaar, Google, Yandex

Members: 1
Guests: 8
Newest Member
Today's Birthdays
There are no member birthdays today.
Related Links
» SmaugMuds.org » Codebases » AFKMud Support & Development » Documentation Question
Forum Rules | Mark all | Recent Posts

Documentation Question
< Newer Topic :: Older Topic > Not asking, giving :)

Pages:<< prev 1 next >>
Post is unread #1 May 9, 2003, 6:37 am
Go to the top of the page
Go to the bottom of the page

The Null Value
GroupAFKMud Team
JoinedFeb 23, 2003

While AFKMud is well documented in the help file department, even more so then the source it was derived from, I see more and more requests for documentation or How-To Guides on how to do various things in the game.

My own staff, however growing, has requested documents such as this, which is leading me in the direction of writing them. I would rather not be greedy though, and I'd like to give back to the community and to AFKMud by writing guides for everyone.

So I ask you, what are you looking for in a guide?

I've already started, but I'm not sure my direction is going to be the best. I'm not sure if I should write from the stand point of myself teaching a complete newbie, or myself teaching someone who also has someone to bounce questions off of. In general, am I writing a Reference Guide (pure documentation, no real explanation of things), or a Tutorial (documentation with help, explanation and even lessons)?

I also ask the question of format. What format should this be in? Should I keep this a plain text file, or a rich-text document? Should I write it in HTML to allow easy hyper-linking between sections, or should I save it to Adobe Acrobat when I'm done?

Also, how much detail should I go into? My thought is to cover every aspect of the game's OLC. Few people understand that OLC does not just cover rooms and areas, but everything changeable online. This would then include Mud Variables, Races, Classes, Deities, Channels, and the list can go on.

Finally, how should I release it? Would you prefer that if I do go for a more complete OLC Guide that I release it as I complete sections, or that I wait until I feel it is near complete and then release it?

Your input is very much so appreciated so that I can ensure I am doing the right thing in this project. I would also love the input of AFKMud's staff. Would you support my effort and inspect what I've written to ensure it is accurate to your understanding of your project?

Post is unread #2 May 9, 2003, 7:09 pm
Go to the top of the page
Go to the bottom of the page

Black Hand
JoinedJan 1, 2002

You have no idea what a burden it would lift to see even partial documentation done for the code. We seem to all have been assimilated by real life responsibilities lately and just don't have enough time. So anything you can come up with helps, and you'll get full credit and such. We'd be happy to verify for accuracy too.

I have but one preference - that any docs NOT be created in PDF format. I despise those things. They're bloat, nothing more. I'm sure others have different opinions, but most of us just hate them. HTML docs would be cool though

Feel free to get as detailed as you want, and it would probably be best to gear them toward beginners.
Post is unread #3 May 9, 2003, 7:52 pm
Go to the top of the page
Go to the bottom of the page

Dementius Rabbitus
JoinedJan 1, 2002

Ah, docs. Terrible time killers. Boring as hell to do, too. *grin* You wanna save me the trouble, feel free.

My own attempts at such have all been under the assumption that the reader hadn't a clue about the first bit of OLC, since that seems what most people need.

I don't really care what format they come in, personally. HTML or .txt, I think would be best. I write in .txt usually.

And by all means, once you finish something, release it. Anything we can get out there is better than what's out there now. ;)
Post is unread #4 May 13, 2003, 9:53 am
Go to the top of the page
Go to the bottom of the page


GroupAFKMud Team
JoinedJan 1, 2002

I agree with both of the above...I barely have time to log in anymore, much less write any documentation. However, as Samson stated, I would be glad to check parts of it for accuracy. Each of us have our own strong points and would probably be willing to check those points. You should've seen how long it took me to get the help files up to date, and that was with a ton of time to devote to writing them ;P But if you progress with this and you want any input as to the direction you've taken or how helpful it appears, I'd be glad to look over it for you.
Pages:<< prev 1 next >>