• Icon: Task Task
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None

      Judging from things I've seen/heard in style and on IRC, the current documentation isn't amazing. It's a bit messy and inconsistent, with many unreviewed pages, and out of date pages.

      The solution to this is to regularly review all documentation. An easy task, right?

      Initially, a completely new set of docs would need to be created from the old docs. The process might become easier after the initial review.

      Each page of the existing wiki docs would be taken and placed in an overall plan in order to create a more organized set of docs. The plan would be discussed in a meeting and approved by developers, and concurrently discussed in mb-style and approved there.

      A set of documentation guidelines should then be created for wiki users creating documentation and style guidelines.

      Finally, several volunteers would then go through each page in the approved plan, and copy content from the existing documentation to the new documentation. Before copying, each page would be reviewed for consistency, relevance, outdated info and general mistakes, using the previously prepared documentation guidelines.

      The end result would be up-to-date documentation with pages organised in a more useful and efficient way, which would hopefully be more useful to both beginners and existing users.

      This would happen at set intervals (eg. 6 months, or a year, or after every schema change)

            lordsputnik Ben Ockmore
            lordsputnik Ben Ockmore
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:

                Version Package