User:Jrconlin/NewProjectTemplate

From MozillaWiki
Jump to: navigation, search
This is a new project template I like to use. It's part checklist to make sure that things don't get forgotten. Please fork and modify.

Official template is here: https://wiki.mozilla.org/Services/Templates/project

ProjectName

Overview

Short summary of the project

Project Contacts

Principal Point of Contact - Name contact@info IRC - #channel Group Email - TBD

Goals

How will you know things are working? What problems does this solve?

Use Cases

How will this be used?

Requirements

  • List of requirements

Get Involved

Call to action for folks who want to help.

Design

Points of Contact

Engineer - Name contact@info

API Reference/Documentation

Data Schema

How will data be stored

API

How to call the data

method URI

description

Arguments argument descriptions
Returns: returned contents

Platform Requirements

What are the things this needs (OS, language, databases, etc.)?

Libraries Required

<i>List of external project dependencies. (Stuff that's not pulled in via the installation script)

Code Repository

Links to the published code bases

Release Schedule

Predicted code delivery dates

QA

Points of Contact

Engineer - Name contact@info

Test Framework

Security and Privacy

Fill out the security & privacy bug template: https://bugzilla.mozilla.org/form.moz-project-review (https://wiki.mozilla.org/Websites/Kick-Off_Form)

For security reviews, there's: https://wiki.mozilla.org/Security/ReviewProcess

Points of Contact

Questionnaire Answers

1.1 Goal of Feature

2. Potential Threat Vectors and Mitigation Points

Review Status

Bugzilla Tracking # - see https://wiki.mozilla.org/Security/Reviews

Issues and Resolutions

Operations

Points of Contact

Deployment Architecture

Bugzilla Tracking # -

Escalation Paths

Lifespan Support Plans

Logging and Metrics

Points of Contact

Tracking Element Definitions

Data Retention Plans

Dashboard URL

Customer Support

Points of Contact

Sumo Tags

Review Meeting