Wiki Template For Projects

Here, a general wiki template to be used in the other projects' wiki pages is defined. This is not final, considered to evolve as learning from experiences. This also can be used as project web site in open source projects.

• Project Info, Overview: General info about the project, history, main goals, current status. Target audience: first visitors.
• Meetings: Customer and internal status meetings, meeting reports (or a photo from the board).
• Releases: Artifacts of the projects, binary, installer, source if applicable. Can be integrated to CI (hudson).
• Schedule: Current and past project timeline, who is doing what, who is planned to do what, when, eta. Scheduling Sys. will be integrated for this purpose.
• User Guide/Documentation: Guide for end user, how to use the stuff, quick start, detailed documentation. Can be also included in artifacts.
• Design & Development: The main active wiki page for development.
  • Architectual Overview
    • All Requirements
    • All Use Cases
  • Component #n
    • Requirements for this component
    • Use cases for this component
    • Implementation notes (Technical Design Documentation / Developer-Milestone log)
      • Final State: Overview of impl. DB schema, domain objects, services, controllers, how use cases are implemented currently.
      • Previous posts related to this component (weekly status, references to changelogs where impl. note is specified in detail)
    • Past, current and future (scheduled) tasks for this component. (Trac ticket reports / timeline from Sch. Sys)

Proposed Naming Conventions

• ProjOverview
• ProjMeetings
  • ProjMeetings/YYYYMMDD
• ProjReleases
  • ProjReleases/VersionXYZ
• ProjSchedule
• ProjUserGuide
• ProjDevelopment
  • ProjArchitecture
    • ProjRequirements
    • ProjUseCases
  • ProjComponent?
    • ProjComponentImpl
      • ProjComponentImplYYYMMDD
    • ProjComponentSchedule