Slick Forums

[ADDED] [IDEA] User Manual Reorganisation
Page 1 of 1

Author:  Mr. Kenkron [ Fri Feb 03, 2012 4:50 pm ]
Post subject:  [ADDED] [IDEA] User Manual Reorganisation

One of the most attractive features of slick is that, for all of it's power, complexity, and extensibility, slick is still easy to learn and use. This ease of use is made possible by clean code, good API documentation, an active forum, and a good user manual. Our user manual has good guides on a great number of topics, but these topics have become so numerous that they are beginning to clutter up the manual page, making it just a bit more difficult to find what you're looking for. I propose that we reorganize the manual so that all of the topics are organized into six sub categories: Slick-Framework, Graphics, Input-Handling, Sound-and-Music, Saving-Local-Settings, and utilities. These six categories do not evenly distribute the manual pages (graphics would have 38 sub-pages, while Saving-Local-Settings would have only 1), but I believe that they are the easiest to navigate.

I have attached a file that contains my proposition for new sub pages and the overarching user manual.

the main menu would be formatted like this:

==== Slick2D user Manual ====

  * [[Slick Framework]]

  * [[Graphics]]

  * [[Input Handling]]

  * [[Sounds and Music]]

  * [[Saving Local Settings]]

  * [[Utilities]]

I could implement this now, but I want to get an opinion from other users before making such a large change. Should the manual be reorganized? If so, is this a good way to organize it? If it should be reorganized differently, how?

Attachments: [1.84 KiB]
Downloaded 269 times

Author:  davedes [ Fri Feb 03, 2012 5:03 pm ]
Post subject:  Re: [IDEA] User Manual Reorganisation

As long as pages aren't removed, I am in favour of making it more organized and easier to navigate. After all, most of the people visiting the wiki will be new to slick and looking for the bare essentials of the library.

Author:  Mr. Kenkron [ Sun Feb 05, 2012 4:12 pm ]
Post subject:  Re: [IDEA] User Manual Reorganisation

A few days have passed, and everyone seems cool with it, do I updated the user manual as described above with slight alterations to the organization of the input handling page. Because an input handling age exists already, the new subcategory is called input, and input handling has been added to the list of input pages wit (overview) following it.

Author:  Tommy [ Sun Feb 05, 2012 6:45 pm ]
Post subject:  Re: [IDEA] User Manual Reorganisation

Nice :D

Looks good, Mr. Kenkron. Thanks for that update!

Author:  Gornova81 [ Sun Feb 05, 2012 7:11 pm ]
Post subject:  Re: [IDEA] User Manual Reorganisation

I like this re-organization, more clear and simple!

Author:  Mr. Kenkron [ Tue Feb 07, 2012 12:16 am ]
Post subject:  Re: [IDEA] User Manual Reorganisation

Thanks, your support means a lot. :)
Did I handle the subject line correctly?

Author:  dime [ Thu Feb 09, 2012 6:02 am ]
Post subject:  Re: [ADDED] [IDEA] User Manual Reorganisation

looking good!

Page 1 of 1 All times are UTC
Powered by phpBB® Forum Software © phpBB Group