wiki:PageTemplates/ProjectPage

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 and how it relates to other projects.


Contents

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


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

Usage

A short description of how the application/tool/service can be used and/or how to get started setting it up as a non-developer. It's useful to add a link to a live instance of the project, if available. If extended (end-user) documentation is available, place a link here.


System Requirements


Dependencies

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


Building and Deploying


Interfaces


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.


Resources

Link to (external) documents, e.g. documentation, papers, requirement analyses, relevant to this project in this section.


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.

Last modified 9 years ago Last modified on 10/22/15 13:56:59