Talk:Player Documentation

From TinyMUX
Jump to: navigation, search

Do we really want to wiki the literal help file text? Seems redundant with the rest of the wiki and a pain to keep up to date... --Javelin 19:10, 1 December 2005 (EST)

I imagine we want to: Document as much as possible, as accurately as possible, and as user-friendly as possible, all without going overboard ;> The help files may often be a good basis for this, but since it's a wiki, I would put extremely little emphasis on helpfiles at all: It's about user input. Besides, if it was about help files, it would've been easier to use some script that serves up formatted helpfiles and does some crosslinking ;> Also, +help seems rather unrelated to anything, since it's not even per codebase, but per game. --Cheetah 12:01, 3 December 2005 (EST)

Help entries not consistent

We need some consistency in how the help is formatted, or it will hurt when we start exporting the information into new help files.

That's the main reason for copying and pasting the original text, so we could have a uniform base to work from.

If someone has extensive experience in mediawiki, we can likely create template(s).

--Tsal 18:33, 5 December 2005 (EST)

I seriously doubt that help files are going to get scrapped from this format back into the restricted case that MUSH allows in general. Rather, I would expect that this will become more of a multi-platform resource that can be referenced externally to the game. It is much easier to read, modify, and update in this format than online. It goes beyond and above what can be accomplished by an in-game helpfile not unlike what many games provide on their websites. I'd rather not see raw help text or even entries pointing to 'help xxxx'. That doesn't provide anything. Just my $0.02 --Mark 19:24, 5 December 2005 (EST)

Well.. Either way, the help files in the game need some updating, too. Ahwell. --Tsal 12:44, 6 December 2005 (EST)
Agreed. I just do not forsee that it will be an easy process to automatically migrate them back from this format. Not that it couldn't be done but I expect it'll require a manual review --Mark 15:51, 6 December 2005 (EST)
Especially since the MUX helpfiles probably don't care about PennMUSH behavior and vice versa, etc.--Javelin 17:10, 6 December 2005 (EST)
I think that information will turn about to be one of the best resources the wiki can offer. Looking at a single location for cross platform information in a readable format will make life much easier. Likewise, I think finding problems in the current documentation becomes easier. When something doesn't work as advertised, notations can be made and the better docs can be submitted to the server devs as a patch or bug. --Mark 21:46, 6 December 2005 (EST)