wiki:PageTemplates/ProjectPage

Version 1 (modified by Twan Goosen, 9 years ago) (diff)

First version, adapted from trac.mpi.nl

  1. Project: Your Project
    1. Contents
    2. People
    3. Getting code
    4. System Requirements
    5. Dependencies
    6. Building and Deploying
    7. Interfaces
    8. Manual
    9. Design
    10. Tickets
    11. Status, Planning and Roadmap
    12. History

Responsible for this page: Your Name?. Last content check: dd-mm-yyyy

Purpose

The purpose of this page is to collect relevant information about Your Project.

Project: Your Project

There should be a summary, roughly one or two paragraphs, of what this project does.


Contents

Contents


People

Name maintainer and other people involved (if possible, also name the best backup, i.e. the person most able to replace maintainer).


Getting code

  • You can browse the code here
  • Check out from: https://trac.clarin.eu/yourproject

System Requirements


Dependencies

What does this project depend on? Which other projects use (part of) this project?


Building and Deploying


Interfaces


Manual


Design

Internal design of the project; class diagrams etc.


Tickets

Usually it's good enough to copy and paste this:

List of all '''open''' tickets for this component:

[[TicketQuery(status=accepted|assigned|new|reopened,component=YourProject,order=priority,format=table,col=summary|priority|owner|reporter)]]

Status, Planning and Roadmap

Status: is the project active, on hold, mature but supported, due to be deprecated, etc.

Planning and roadmap: if there are other places with planning documents, don't forget to link to them.


History

Who has worked on this project, and roughly what did they do? Mention significant developments even if the relevant code/functionality has later been removed. Include yourself, of course.