Confirmed users
1,022
edits
CloudServices/Templates/project: Difference between revisions
Jump to navigation
Jump to search
CloudServices/Templates/project (view source)
Revision as of 16:33, 17 October 2013
, 17 October 2013no edit summary
(Created page with "<h1>ProjectName</h1> =Overview= ==Project Contacts== ''IRC'' - ''Group Email'' - ==Goals== ==Use Cases== ==Requirements== ==Get Involved== =Design= ==Points of Contact== ==AP...") |
No edit summary |
||
| Line 1: | Line 1: | ||
<h1>ProjectName</h1> | <div style="border:1px solid #444;background-color:#ccc;">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.</div> | ||
=Overview= | <!-- And, obviously change the names of stuff --> | ||
<h1><i>ProjectName</i></h1> | |||
==Overview== | |||
<i>Short summary of the project </i> | |||
==Project Contacts== | ==Project Contacts== | ||
''IRC'' - | ''Principal Point of Contact'' - <i>Name</i> <i>contact@info</i> | ||
''IRC'' - #<i>channel</i> | |||
''Group Email'' - | ''Group Email'' - TBD | ||
==Goals== | ==Goals== | ||
<i>How will you know things are working?</i> | |||
<i>What problems does this solve?</i> | |||
==Use Cases== | ==Use Cases== | ||
<i>How will this be used?</i> | |||
==Requirements== | ==Requirements== | ||
* <i>List of requirements</i> | |||
==Get Involved== | ==Get Involved== | ||
<i>Call to action for folks who want to help.</i> | |||
=Design= | =Design= | ||
==Points of Contact== | ==Points of Contact== | ||
Engineer - <i>Name</i> <i>contact@info</i> | |||
==API Reference/Documentation== | ==API Reference/Documentation== | ||
=== Data Schema === | |||
<i>How will data be stored</i> | |||
=== API === | |||
<i>How to call the data</i> | |||
==== <i>method</i> <i>URI</i> ==== | |||
<i>description</i> | |||
Arguments <i>argument descriptions</i> | |||
Returns: <i>returned contents</i> | |||
==Platform Requirements== | ==Platform Requirements== | ||
<i>What are the things this needs (OS, language, databases, etc.)? | |||
==Libraries Required== | ==Libraries Required== | ||
<i>List of external project dependencies. (Stuff that's not pulled in via the installation script)</i> | |||
==Code Repository== | ==Code Repository== | ||
<i>Links to the published code bases</i> | |||
==Release Schedule== | ==Release Schedule== | ||
<i>Predicted code delivery dates</i> | |||
=QA= | =QA= | ||
==Points of Contact== | ==Points of Contact== | ||
Engineer - <i>Name</i> <i>contact@info</i> | |||
==Test Framework== | ==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== | ==Points of Contact== | ||
==Questionnaire Answers== | |||
===1.1 Goal of Feature === | |||
===2. Potential Threat Vectors and Mitigation Points=== | |||
==Review Status== | ==Review Status== | ||
''Bugzilla Tracking #'' - | ''Bugzilla Tracking #'' - | ||
| Line 33: | Line 65: | ||
=Operations= | =Operations= | ||
==Points of Contact== | ==Points of Contact== | ||
==Deployment Architecture== | ==Deployment Architecture== | ||
''Bugzilla Tracking # '' - | ''Bugzilla Tracking # '' - | ||
==Escalation Paths== | ==Escalation Paths== | ||
==Lifespan Support Plans== | ==Lifespan Support Plans== | ||
=Logging and Metrics= | =Logging and Metrics= | ||
==Points of Contact== | ==Points of Contact== | ||
| Line 44: | Line 76: | ||
==Data Retention Plans== | ==Data Retention Plans== | ||
==Dashboard URL== | ==Dashboard URL== | ||
=Customer Support= | =Customer Support= | ||
==Points of Contact== | ==Points of Contact== | ||
==Sumo Tags== | ==Sumo Tags== | ||
==Review Meeting== | ==Review Meeting== | ||