Difference between revisions of "Blank Stable Release Tool Example"

From OWASP
Jump to: navigation, search
(Initial creation of a stable tool release example - pre-assessment complete)
 
(Initial creation of a stable tool release example - reviewer tabs complete)
Line 7: Line 7:
 
==== Project Leader for this Release ====
 
==== Project Leader for this Release ====
  
'''''<nowiki>[Project Lead]</nowiki>'s Pre-Assessment Checklist:'''''  
+
'''''<nowiki>[Project Lead]</nowiki>'s Pre-Assessment Checklist:'''''
 +
 
 
<!-- ###############################################################################
 
<!-- ###############################################################################
     ##                                                                         ##
+
     ##                                                                           ##
     ##          START SECTION TO BE COMPLETED BY THE PROJECT LEAD             ##
+
     ##          START SECTION TO BE COMPLETED BY THE PROJECT LEAD               ##
     ##                                                                         ##
+
     ##                                                                           ##
 
     ###############################################################################-->
 
     ###############################################################################-->
 
{|style="width:100%; background:#white" align="left"
 
{|style="width:100%; background:#white" align="left"
Line 166: Line 167:
  
 
<!-- ###############################################################################
 
<!-- ###############################################################################
     ##                                                                         ##
+
     ##                                                                           ##
     ##          END OF SECTION TO BE COMPLETED BY THE PROJECT LEAD             ##
+
     ##          END OF SECTION TO BE COMPLETED BY THE PROJECT LEAD               ##
     ##                                                                         ##
+
     ##                                                                           ##
 
     ###############################################################################-->
 
     ###############################################################################-->
  
Line 174: Line 175:
  
 
<!-- ###############################################################################
 
<!-- ###############################################################################
     ##                                                                         ##
+
     ##                                                                           ##
     ##          START SECTION TO BE COMPLETED BY THE FIRST REVIEWER             ##
+
     ##          START SECTION TO BE COMPLETED BY THE FIRST REVIEWER             ##
     ##                                                                         ##
+
     ##                                                                           ##
 
     ###############################################################################-->
 
     ###############################################################################-->
 +
 +
'''''<nowiki>[First Reviewer]</nowiki>'s Review:'''''
 +
 +
{|style="width:100%; background:#white" align="left"
 +
|style="width:100%; background:#white" align="left"|'''Beta Release Level Questions'''
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''1. Is an installer for the tool available and easy to use? How close does it reach the goal of a fully automated installer?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|- 
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''2. Is the end user documentation complete, relevant and presented on the OWASP wiki page?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here.
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|- 
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''3. Does the tool have an “About box” or similar help item which allows the end user to get an overview of the state of this tool? Is this information readily available and easy to find?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''4. Does the documentation on building the source provide the necessary information and detail to allow someone to build the tool? Is there sufficient detail and information for the target user? Is there any domain specific knowledge that is assumed and not provided?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''5. Is the tool's documentation available with the source code and would it readily discoverable by a new user of the tool?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|'''Stable Release Level Questions'''
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
''6. Does the tool substantially address the application security issues it was created to solve?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|- 
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''7. Is the tool reasonably easy to use?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''8. Does the documentation meet the needs of the tool users and is easily found?'' 
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''9. Do the build scripts work as expected? Can you build the tool? The goal is a “One-click” build.''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''10. Is the bug tracking system usable? Is it hosted at the same place as the source code? (e.g. Google Code, Sourceforge)''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''11. Have you noted any limitations of the tool that are not already documented by the project lead.''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''12. Would you consider using this tool in your day to day work assuming your professional work includes a reason to use this tool? Why or why not?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''13. What, if anything, is missing which would make this a more useful tool? Is what is missing critical enough to keep the release at a beta quality?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|}
  
 
<!-- ###############################################################################
 
<!-- ###############################################################################
     ##                                                                         ##
+
     ##                                                                           ##
     ##        END OF SECTION TO BE COMPLETED BY THE FIRST REVIEWER             ##
+
     ##        END OF SECTION TO BE COMPLETED BY THE FIRST REVIEWER             ##
     ##                                                                         ##
+
     ##                                                                           ##
 
     ###############################################################################-->
 
     ###############################################################################-->
  
 
==== Second Reviewer ====
 
==== Second Reviewer ====
 
<!-- DO NOT FORGET TO PUT BIT ABOUT GPC / OWASP BOARD -->
 
  
 
<!-- ###############################################################################
 
<!-- ###############################################################################
     ##                                                                         ##
+
     ##                                                                           ##
     ##        START SECTION TO BE COMPLETED BY THE SECOND REVIEWER             ##
+
     ##        START SECTION TO BE COMPLETED BY THE SECOND REVIEWER             ##
     ##                                                                         ##
+
     ##                                                                           ##
 
     ###############################################################################-->
 
     ###############################################################################-->
  
<!-- ###############################################################################
+
'''''<nowiki>[Second Reviewer]</nowiki>'s Review:'''''<br />
    ##                                                                          ##
+
<small>Second Review was a member of the OWASP Board/Global Projects Committee/OWASP Leaders List</small>
    ##        END OF SECTION TO BE COMPLETED BY THE SECOND REVIEWER            ##
+
    ##                                                                          ##
+
    ###############################################################################-->
+
 
+
==== GPC/OWASP Board ====
+
  
 +
{|style="width:100%; background:#white" align="left"
 +
|style="width:100%; background:#white" align="left"|'''Beta Release Level Questions'''
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''1. Is an installer for the tool available and easy to use? How close does it reach the goal of a fully automated installer?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|- 
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''2. Is the end user documentation complete, relevant and presented on the OWASP wiki page?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here.
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|- 
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''3. Does the tool have an “About box” or similar help item which allows the end user to get an overview of the state of this tool? Is this information readily available and easy to find?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''4. Does the documentation on building the source provide the necessary information and detail to allow someone to build the tool? Is there sufficient detail and information for the target user? Is there any domain specific knowledge that is assumed and not provided?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''5. Is the tool's documentation available with the source code and would it readily discoverable by a new user of the tool?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|'''Stable Release Level Questions'''
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
''6. Does the tool substantially address the application security issues it was created to solve?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|- 
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''7. Is the tool reasonably easy to use?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''8. Does the documentation meet the needs of the tool users and is easily found?'' 
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''9. Do the build scripts work as expected? Can you build the tool? The goal is a “One-click” build.''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''10. Is the bug tracking system usable? Is it hosted at the same place as the source code? (e.g. Google Code, Sourceforge)''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''11. Have you noted any limitations of the tool that are not already documented by the project lead.''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''12. Would you consider using this tool in your day to day work assuming your professional work includes a reason to use this tool? Why or why not?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|-
 +
| style="width:100%; background:#white" align="left"|
 +
<!-- ############## QUESTION BELOW ############## -->
 +
''13. What, if anything, is missing which would make this a more useful tool? Is what is missing critical enough to keep the release at a beta quality?''
 +
----
 +
<!-- ############## RESPOND BELOW THIS LINE ############## -->
 +
Delete this text and place your answer here. 
 +
<!-- ############## RESPOND ABOVE THIS LINE ############## -->
 +
----
 +
|-
 +
| style="width:100%; background:#C2C2C2" align="left"|<!-- Provides a spacer -->
 +
|}
  
 +
<!-- ###############################################################################
 +
    ##                                                                          ##
 +
    ##        END OF SECTION TO BE COMPLETED BY THE SECOND REVIEWER              ##
 +
    ##                                                                          ##
 +
    ###############################################################################-->
  
  

Revision as of 23:11, 20 June 2009

Click here to return to the tool assessment criteria


Stable Release Review of [Project Name] [Release Name and Version]

Project Leader for this Release

[Project Lead]'s Pre-Assessment Checklist:

Alpha level

1. Is your tool licensed under an open source license?

2. Is the source code and any documentation available in an online project repository? (e.g. Google Code or Sourceforge site)

3. Is there working code?

4. Is there a roadmap for this project release which will take it from Alpha to Stable release?

Beta Level

5. Are the Alpha pre-assessment items complete?

6. Is there an installer or stand-alone executable?

7. Is there user documentation on the OWASP project wiki page?

8. Is there an "About box" or similar help item which lists the following:

  • Project Name?
  • Short Description?
  • Project Lead and contact information?(e.g. email address)
  • Project Contributors (if any)?
  • License?
  • Project Sponsors (if any)?
  • Release status and date assessed as Month-Year e.g. March 2009?
  • Link to OWASP Project Page?

9. Is there documentation on how to build the tool from source including obtaining the source from the code repository?

10. Is the tool documentation stored in the same repository as the source code?

Stable Level

11. Are the Alpha and Beta pre-assessment items complete?

12. Does the tool include documentation built into the tool?

13. Does the tool include build scripts to automate builds?

14. Is there a publicly accessible bug tracking system?

15. Have any existing limitations of the tool been documented?



First Reviewer

[First Reviewer]'s Review:

Beta Release Level Questions

1. Is an installer for the tool available and easy to use? How close does it reach the goal of a fully automated installer?


Delete this text and place your answer here.


2. Is the end user documentation complete, relevant and presented on the OWASP wiki page?


Delete this text and place your answer here.


3. Does the tool have an “About box” or similar help item which allows the end user to get an overview of the state of this tool? Is this information readily available and easy to find?


Delete this text and place your answer here.


4. Does the documentation on building the source provide the necessary information and detail to allow someone to build the tool? Is there sufficient detail and information for the target user? Is there any domain specific knowledge that is assumed and not provided?


Delete this text and place your answer here.


5. Is the tool's documentation available with the source code and would it readily discoverable by a new user of the tool?


Delete this text and place your answer here.


Stable Release Level Questions

6. Does the tool substantially address the application security issues it was created to solve?


Delete this text and place your answer here.


7. Is the tool reasonably easy to use?


Delete this text and place your answer here.


8. Does the documentation meet the needs of the tool users and is easily found?


Delete this text and place your answer here.


9. Do the build scripts work as expected? Can you build the tool? The goal is a “One-click” build.


Delete this text and place your answer here.


10. Is the bug tracking system usable? Is it hosted at the same place as the source code? (e.g. Google Code, Sourceforge)


Delete this text and place your answer here.


11. Have you noted any limitations of the tool that are not already documented by the project lead.


Delete this text and place your answer here.


12. Would you consider using this tool in your day to day work assuming your professional work includes a reason to use this tool? Why or why not?


Delete this text and place your answer here.


13. What, if anything, is missing which would make this a more useful tool? Is what is missing critical enough to keep the release at a beta quality?


Delete this text and place your answer here.



Second Reviewer

[Second Reviewer]'s Review:
Second Review was a member of the OWASP Board/Global Projects Committee/OWASP Leaders List

Beta Release Level Questions

1. Is an installer for the tool available and easy to use? How close does it reach the goal of a fully automated installer?


Delete this text and place your answer here.


2. Is the end user documentation complete, relevant and presented on the OWASP wiki page?


Delete this text and place your answer here.


3. Does the tool have an “About box” or similar help item which allows the end user to get an overview of the state of this tool? Is this information readily available and easy to find?


Delete this text and place your answer here.


4. Does the documentation on building the source provide the necessary information and detail to allow someone to build the tool? Is there sufficient detail and information for the target user? Is there any domain specific knowledge that is assumed and not provided?


Delete this text and place your answer here.


5. Is the tool's documentation available with the source code and would it readily discoverable by a new user of the tool?


Delete this text and place your answer here.


Stable Release Level Questions

6. Does the tool substantially address the application security issues it was created to solve?


Delete this text and place your answer here.


7. Is the tool reasonably easy to use?


Delete this text and place your answer here.


8. Does the documentation meet the needs of the tool users and is easily found?


Delete this text and place your answer here.


9. Do the build scripts work as expected? Can you build the tool? The goal is a “One-click” build.


Delete this text and place your answer here.


10. Is the bug tracking system usable? Is it hosted at the same place as the source code? (e.g. Google Code, Sourceforge)


Delete this text and place your answer here.


11. Have you noted any limitations of the tool that are not already documented by the project lead.


Delete this text and place your answer here.


12. Would you consider using this tool in your day to day work assuming your professional work includes a reason to use this tool? Why or why not?


Delete this text and place your answer here.


13. What, if anything, is missing which would make this a more useful tool? Is what is missing critical enough to keep the release at a beta quality?


Delete this text and place your answer here.