Jump to: navigation, search

Difference between revisions of "Neutron/BlueprintTemplate"

 
Line 4: Line 4:
  
 
== Template ==
 
== Template ==
'''High level description''''''<<BR>> '''[Short overview and high level description of what the blueprint is trying to achieve.]
+
'''High level description''''''
 +
'''[Short overview and high level description of what the blueprint is trying to achieve.]
  
'''<u>API's</u><<BR>>'''[List and explanation of the    new API's (if they exist)]
+
'''<u>API's</u>
 +
'''[List and explanation of the    new API's (if they exist)]
  
'''Configuration variables''' [List and explanation of the    new configuration variables (if they exist)]
+
'''Configuration variables'''
 +
[List and explanation of the    new configuration variables (if they exist)]
  
'''<u>Algorithm</u><<BR>>'''[Provide an overview of any algorithms that will be used]
+
'''<u>Algorithm</u>
 +
'''[Provide an overview of any algorithms that will be used]
  
'''<u>Data Model Changes</u><<BR>>'''[Are you introducing new model classes, or extending existing ones?]
+
'''<u>Data Model Changes<<BR>></u>'''[Are you introducing new model classes, or extending existing ones?]
  
'''<u>Plugin Interface</u><<BR>>'''[Does this feature introduce any change?]
+
'''<u>Plugin Interface<<BR>></u>'''[Does this feature introduce any change?]
  
'''<u>Required Plugin support</u><<BR>>'''[What should the plugins do to support this new feature? (If applicable)]
+
'''<u>Required Plugin support</u>
 +
'''[What should the plugins do to support this new feature? (If applicable)]

Revision as of 10:28, 23 October 2012

Blueprint Template

Below is an outline for a Blueprint Summary template. The purpose is to try and improve our development, review and release process. Please make sure that you include the sections below. If the section is not relevant the a simple N/A will suffice. In addition to this any links to diagrams will be graetly appreciated - this will be very helpful when we are documenting the feature release.

Template

High level description' [Short overview and high level description of what the blueprint is trying to achieve.]

API's [List and explanation of the new API's (if they exist)]

Configuration variables [List and explanation of the new configuration variables (if they exist)]

Algorithm [Provide an overview of any algorithms that will be used]

Data Model Changes<
>
[Are you introducing new model classes, or extending existing ones?]

Plugin Interface<
>
[Does this feature introduce any change?]

Required Plugin support [What should the plugins do to support this new feature? (If applicable)]