Chaosforge Forum

Other Roguelikes => Berserk! => Topic started by: Kornel Kisielewicz on January 04, 2007, 15:30

Title: Request for Help : Improved Documentation
Post by: Kornel Kisielewicz on January 04, 2007, 15:30

Ok, one of the requests was an improved documentation. As I am currently very overworked (and in the name of teamwork), I'd like you guys to help me out. I even don't have an idea what should be put into the doc files :). As for presentation, it will be a copy of DoomRL's help system, so a few sections with text and basic formatting.

Here's a guest page on the DoomRL Wiki for the manual. You need to register and confirm your email to edit:
http://doom.chaosforge.org/wiki/index.php?title=Berserk%21_Manual

Anyone will help?

Title: Re: Request for Help : Improved Documentation
Post by: Adral on January 04, 2007, 15:37

I can try to help. But keep in mind it's exam time on my university, so I might only have little time left.

I'll do whatever I can do, though :).

Title: Re: Request for Help : Improved Documentation
Post by: Adral on January 04, 2007, 15:39

Double post, FOR THE EMPEROR!

Yeah, set up that Wiki page. It will make it much easier contributing as a whole group.

I double posted so you read again this post in case you've read my other reply, sorry :/.

Title: Re: Request for Help : Improved Documentation
Post by: Kornel Kisielewicz on January 04, 2007, 15:55

Ok, I added the wiki page:
http://doom.chaosforge.org/wiki/index.php?title=Berserk%21_Manual

Title: Re: Request for Help : Improved Documentation
Post by: Kornel Kisielewicz on January 13, 2007, 03:17

Topic bump! Please help :]

Title: Re: Request for Help : Improved Documentation
Post by: Adral on January 13, 2007, 04:46

I've added keybindings on the wiki.

I think disclaimer should be done by your personally, Kornel (as it's you who should impose any restriction on usage, copying or whatever you feel like, it's your game!)

With Credits, pretty much the same. It's you who should credit beta testers, loved ones, people who gave you ideas/support, and all this things people put when dedicating a game :P

If you think anything needs improvement, please note it and I'll try to add things when I can!

Title: Re: Request for Help : Improved Documentation
Post by: Kornel Kisielewicz on January 13, 2007, 05:02

It would be good to make all sections complete (except Disclaimer and Credits). Before Berserk! 0.8 will be officialy released, I'll make a Berserk! Release Candidate - then you'll have time to update the documentation :).

Who knows, maybe the RC will be available today ;]

Title: Re: Request for Help : Improved Documentation
Post by: Adral on January 13, 2007, 05:21

Must... have... new... version...

Title: Re: Request for Help : Improved Documentation
Post by: Kornel Kisielewicz on January 14, 2007, 13:51

What's left to do:
-- add new version features info into Getting Started
-- cleanup and update the missing parts of the Getting Started section
-- cleanup the Keybindings section
-- eventually propose another section for the help system

Title: Re: Request for Help : Improved Documentation
Post by: Adral on January 23, 2007, 15:31

I'll try to work on the wiki again soon, now that I finally ended my exams.

I'll try to start tomorrow completing the documentation. Any help is appreciated, too:P

Title: Re: Request for Help : Improved Documentation
Post by: Kornel Kisielewicz on January 23, 2007, 16:28

As a base please take the help files from the game itself (they're in the folder help).