Requirements

• Translatable
• Version-safe (users should not get docs in their bundle that does not match the pocoo version, important if there is a maintainance and dev branch)
• Context help - directly jump to or display help texts that fit the current form
• should be available at http://example.com/help (see phpbb/vbulletin)
• included in every downloaded package and online available

Documentation Scenarios

• moinmoin wiki -> http://moinmoin.wikiwikiweb.de/ Advantages: Export as PDF, HTML, DocBook? etc. using of the plugins... Disadvantages: None till now.
• RST Files -> http://docutils.sourceforge.net (demo: http://docutils.sourceforge.net/docs/user/rst/demo.html interactive: http://www.hosting4u.cz/jbar/rest/rest.html) Advantages: It is easy to transport the doku in the download-package. Disadvantages: None till now.
• Documentation like here parallel to moinmoin (export function of moin): http://www.gentoo.org/doc/de/ (http://moinmoin.wikiwikiweb.de/WikiXml?highlight=%28xml%29)

Chosen solution

• Moin runs on http://docs.pocoo.org/
• Pages get shipped on release

Ideas for Working with the MoinMoin?

• creating a SVN, because otherwise developers for this wiki are working a little bit in the darkness
• letting pocoo-documentation become possibility, that can be chosen in the trac for the tickets. So everything is together in the ticket-system.
• Anything explanations about the installation should be independent from the platform pocoo is installed on. Maybe it would be a idea have a block of needed knowledge at the head of the page.(like ubuntuusers.de is doing here) The linked articles are constisting of links to the documentations of the platforms. So we don't have to think about having this always up-to-date.

Table of Contents

Let us think about the topics that need to be explained in the user documentation.

• Introduction
  • The philosophy behind pocoo
  • Comparison with other alternate forum systems
  • System Requirements
  • What do you need really?
  • What is recommended?
• Installation
  • Prearrangements
  • Basic Installation
  • Finally installation steps
• Configuration
  • The configuration Files/Sections
• The features of pocoo
  • What features only pocoo has?
  • How can I extend pocoo -> PLUGINS!
  • Explanation of the plugin structure
• How you can use the whole power of pocoo
  • A Howto how to improve the whole possibilities of pocoo
  • Tuning functions
• How to look at forums
  • How to edit/change the design of pocoo, maybe templates?
• How to write posts
  • Some rules to write good posts
  • Sourcecode function
• How to administrate pocoo
  • Handling of Spam
  • How to run pocoo in the securest way

Feel free to add your ideas here.