Difference between revisions of "User:Enus Linden/Project-Wiki-Structure"
Jump to navigation
Jump to search
Enus Linden (talk | contribs) |
Enus Linden (talk | contribs) |
||
| Line 6: | Line 6: | ||
Project - main page | Project - main page | ||
:: #Overview - basic description of the project goals and justification. repository, irc, mailing lists, meeting info. | :: #Overview - 1 to 2 lines, basic description of the project goals and justification, links to related info. Ways to participate: repository location, irc, mailing lists, meeting info. | ||
:: #Status - | :: #Status - 1 line version, pointers to jiras | ||
:: #Roadmap - at a high level, plus link to Project/Roadmap | :: #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) | :: #Documentation - outline containing links to supporting docs in the wiki, not the documentation itself. (e.g. Project/Specification) | ||
:: #Links - shortcut to Project/Links | :: #Links - shortcut to Project/Links | ||
:: #Licensing - if needed | :: #Licensing - if needed | ||
: Project/ | : Project/Background- 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/Roadmap - Status at the top. 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/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 - a summary page for supporting docs (or just an unnecessary level if not an actual page) | ||
| Line 22: | Line 22: | ||
::::: Project/Documentation/Specification/Component1(-n)#Details | ::::: Project/Documentation/Specification/Component1(-n)#Details | ||
:: Project/Documentation/Examples - tutorials and the like on usage of Project | :: Project/Documentation/Examples - tutorials and the like on usage of Project | ||
:: Project/Documentation/{etc} | |||
---- | ---- | ||
| Line 29: | Line 30: | ||
[[Pyogp]] | [[Pyogp]] | ||
:: [[Pyogp#Overview]] | :: [[Pyogp#Overview]] - intro, links to lib and test harness, links to AWG and OGP | ||
:: [[Pyogp#Status]] | :: [[Pyogp#Status]] | ||
:: [[Pyogp#Documentation]] | :: [[Pyogp#Documentation]] | ||
:: [[Pyogp#Links]] | :: [[Pyogp#Links]] | ||
:: [[Pyogp#Licensing]] | :: [[Pyogp#Licensing]] | ||
: [[Pyogp/ | : [[Pyogp/Background]] | ||
: [[Pyogp/Roadmap]] | : [[Pyogp/Roadmap]] - split by library and test harness | ||
: [[Pyogp/Links]] | : [[Pyogp/Links]] | ||
::: [[Pyogp/Links#Project Wiki]] | ::: [[Pyogp/Links#Project Wiki]] | ||
| Line 55: | Line 55: | ||
::::: [[Pyogp/Documentation/Specification/pyogp.test-thingy#Test_Cases]] | ::::: [[Pyogp/Documentation/Specification/pyogp.test-thingy#Test_Cases]] | ||
:: [[Pyogp/Documentation/Examples]] | :: [[Pyogp/Documentation/Examples]] | ||
:: [[Pyogp/Documentation/Coding Guidelines]] | |||
Revision as of 16:22, 22 July 2008
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 - 1 to 2 lines, basic description of the project goals and justification, links to related info. Ways to participate: repository location, irc, mailing lists, meeting info.
- #Status - 1 line 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/Background- more in depth info about the project, essentially a verbose version of the Project#Overview.
- Project/Roadmap - Status at the top. 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/Specification/Component1(-n) - component details
- Project/Documentation/Examples - tutorials and the like on usage of Project
- Project/Documentation/{etc}
Using Pyogp as an example, it could look something like this:
- Pyogp#Overview - intro, links to lib and test harness, links to AWG and OGP
- Pyogp#Status
- Pyogp#Documentation
- Pyogp#Links
- Pyogp#Licensing
- Pyogp/Background
- Pyogp/Roadmap - split by library and test harness
- Pyogp/Links
- Pyogp/Links#Project Wiki
- Pyogp/Links#OGP Docs
- Pyogp/Links#Other - (Tao's blog links, Legacy work, etc)
- Pyogp/Documentation