Difference between revisions of "Documents Assessment Criteria"

From OWASP
Jump to: navigation, search
(initial input)
 
(initial input)
Line 5: Line 5:
 
This page is maintained by the [[Global Projects Committee]] to help assist Project Leaders with information about successfully running an OWASP Project. It will be updated from time to time, and changes will be discussed and announced on the OWASP-Leaders list.
 
This page is maintained by the [[Global Projects Committee]] to help assist Project Leaders with information about successfully running an OWASP Project. It will be updated from time to time, and changes will be discussed and announced on the OWASP-Leaders list.
  
====Alpha Quality Document Criteria====
+
====Alpha Release Document Criteria====
  
 
Pre-Assessment Checklist:
 
Pre-Assessment Checklist:
Line 16: Line 16:
  
  
====Beta Quality Document Criteria====
+
====Beta Release Document Criteria====
  
 
Pre-Assessment Checklist:
 
Pre-Assessment Checklist:
Line 38: Line 38:
  
  
====Release Quality Document Criteria====
+
====Quality Release Document Criteria====
  
 
Pre-Assessment Checklist:
 
Pre-Assessment Checklist:

Revision as of 14:49, 20 April 2009


This is a DRAFT page still under review by the Global Projects Committee

This page is maintained by the Global Projects Committee to help assist Project Leaders with information about successfully running an OWASP Project. It will be updated from time to time, and changes will be discussed and announced on the OWASP-Leaders list.

Alpha Release Document Criteria

Pre-Assessment Checklist:

  1. Is your document licensed under a free and open license? (see Project Licensing section of the Guidelines for OWASP Projects)
  2. Is the Project Identification template on the project wiki page complete and accurate?
  3. Is the document compiled into an exported (PDF) and editable (.Doc) format available on-line?
  4. Are all articles that constitute the project properly tagged within project category and available from main project Wiki page?
  5. Is there an OWASP mail list for the project?
  6. Is there a statement of the application security issue the document addresses on the OWASP project wiki page?


Beta Release Document Criteria

Pre-Assessment Checklist:

  1. Are all document contents (articles) present and listed on the OWASP project wiki page?
  2. Is there an “About This Document” section in the document listing:
    1. Document Name
    2. Author(s)
    3. Contributor(s)
    4. Contact email address
    5. Current version and/or release date
    6. Project's web page address
  3. Is the document compiled into an exported (PDF) and editable (.Doc) format available on-line?
  4. Are all articles that constitute the project properly tagged within project category and available from main project Wiki page?
  5. Are the Alpha pre-assessment items complete?


Reviewer Action Items:

  1. Does the document consider the OWASP Writing Style?
  2. Do contents from wiki articles match compiled document?
  3. Does the document have an “About This Document” section which allows the end user to get an overview of the state of the document?


Quality Release Document Criteria

Pre-Assessment Checklist:

  1. Have any limitations been documented?
  2. Is there a conference style presentation that describes the document in at least 3 slides?
  3. Is there a one sheet overview document about the project?
  4. Does the document considering OWASP Writing Style and OWASP Template for Docs?
  5. Is there a one sheet overview document about the project?
  6. Are the Alpha and Beta pre-assessment items complete?


Reviewer Action Items:

  1. Does the document substantially address the application security issues it was created to solve?
  2. Does the document respecting OWASP Writing Style and OWASP Template for Docs?
  3. Have you noted any limitations of the document that are not already documented by the project lead.
  4. Have all the Beta Reviewer Action Items been completed? These will need to be completed if they have not already occurred during a previous assessment.