User:Enus Linden/Project-Wiki-Structure

The following is a proposal for a stucture for a generic project documentation set on wiki.secondlife.com. Specifically, Pyogp is in need of this like yesterday...

Here is a possible summary of pages and their contents:

Project - main page

#Overview - basic description of the project goals and justification. repository, irc, mailing lists, meeting info. Also contains links to transcripts and the like

#Status - Short version, pointers to jiras

#Roadmap - at a high level, plus link to Project/Roadmap

#Documentation - outline containing links to supporting docs in the wiki, not the documentation itself. (e.g. Project/Specification)

#Links - shortcut to Project/Links

#Licensing - if needed

Project/History - more in depth info about the project, essentially a verbose version of the Project#Overview.

Project/Roadmap - full version of Project#Roadmap, with all known tasks. If Milestones and dates are relevant, this is the right place to say so.

Project/Links - A comprehensive list of links of all project related wiki pages, plus supporting external resources

Project/Documentation - a summary page for supporting docs (or just an unnecessary level if not an actual page)

Project/Documentation/Requirements - description of the requirements for the project, with pointers to external resources as needed

Project/Documentation/Specification - high level component overview (usage examples as appropriate). Status of the component ought to be indicated, and synced with the Project/Roadmap page)

Project/Documentation/Specification/Component1(-n) - component details

Project/Documentation/Specification/Component1(-n)#Overview

Project/Documentation/Specification/Component1(-n)#Details

Project/Documentation/Examples - tutorials and the like on usage of Project

Using Pyogp as an example, it could look something like this: