Project Description Template for CrisisCommons.org
From CrisisCommons Wiki
|
This page suggests information you should provide on your project wiki, in order to:
- help your project be successful
- attract the needed people
- get the right stuff done with the right priority/urgency
So the information in your entry can help to recruit new participants, coordinate among existing participants, and inform the community of your goals and progress.
[edit] Procedure
The first and second sections (Blurb and Customer sections) are strongly recommended. For the other sections, just fill out the parts that make sense for your project.
To create an entry for a project:
- On the Projects Page, create an entry for your new project: Enter "New Project: " and then the name of your project in [[double brackets]]; be sure to save this edit
- Go to this new entry on the Projects page and click on the red link to your project; this will create the page for your project.
- Return to this page and copy the entire Template section from below
- Return to your project page and paste the Template.
- Complete all of the template's fields that you wish, but please complete as much of the Blurb and Customer portions that you can; be sure to save it.
- Copy the Blurb from your project, into the entry on the Projects page for your project; be sure to save it.
- Update your detailed project page, as the project progresses. Be sure to copy any changes in the Blurb section up to the entry for your project on the Projects page.
NOTE: If there is a handoff from one project leader to another please be sure to update both the individual project page, and also any details written on the Projects list. This will allow anyone interested in the project, as well as those active with the project, to know who they need to contact for coordination.
[edit] Template:
copy & paste this template onto your wiki page
The '''xxxx project''' is all about yyyy. Short two-sentence introduction == Front Page Blurb == * Current Primary Contact: (Name, email, IM, City location, phone, twitter) * '''Brief Description''' (one or a few lines) * Status * '''Project Communications''' ** mailing list or forum: ** irc: ** twitter: ** code or data repositories: * Leads (Name, email, IM, City location, phone, twitter) ** Technical: ** Project: * '''Skills and Other Resources Needed''' * '''Objectives or Goals''' (bullet list) == For Your Customers == * Who will benefit? * '''How will they find out about it?''' * '''How can they get it?''' * What will they do with it, or how will they use it? * Can they get help using it? * What skills or other stuff do they need in order to use it? * Does it work with (or require) other applications or tools? == More Detailed Information == Provide below details if appropriate for your particular project: * Detailed Description, images, etc. (or links to) * Other Principals / Coordinators (Name, email, IM, City location, phone, twitter) ** Documentation Lead(s) ** Deployment Lead(s) ** Government Contact(s) ** NGO Contact(s) ** Haiti Citizen Contact(s) ** Foreign Citizen Contact(s) * Contributors / Collaborators / Team Members * Links ** completed apps ** license (eg., GPL) ** news stories ** related projects == Project Activity == * Results to Date ** work done per city, per time block ** hand-offs from city to city (follow the sun!) * Feedback from Users or from the Field == Implementation Plan == For projects that need planning and specific outcomes: * Functional Requirements * Intended Deployment (What, Where, How, Who, When) ** and Recruitment (Who will use it, how do you publicize it) * Architecture * Task Breakdown / Backlog, and Priorities ** implementation, testing, deployment, recruitment * Notes, suggestions, conclusions
