文档评估标准

From OWASP
Jump to: navigation, search


该网页由OWASP中文项目组维护,以帮助OWASP中文项目的领导人和项目参与人员,依据《2.0版评估标准》(Assessment Criteria v2.0),在项目发布以前,对项目的文档进行评估。

文档Alpha发布的标准

评估前的检查列表:

  1. 该项发布涉及的项目是否至少包含“项目Wiki最少页数内容”信息?
  2. 你的文档是否符合一个免费且开源许可证?(参见Guidelines for OWASP Projects的“项目许可”部分)
  3. 文档是否在项目的网页里以PDF和.doc的格式提供?
  4. 项目发布的所有文档,是否被项目种类正确标记,并且可以从项目的Wiki主页获得?
  5. 该项目发布是否有一个从Alpha发布到稳定发布的路线图?


文档Beta发布的标准

评估前的检查列表:

  1. 在Alpha发布中,评估前检查列表中的项目是否完成?
  2. 是否所有的文档内容在OWASP项目wiki网页中呈现并列举?
  3. 在文档中是否包含“关于该文档”章节以列举:
    1. (项目发布的)文档名称
    2. 作者
    3. 参与人员
    4. Email地址
    5. 目前版本(或包含发布时间)
    6. 项目网页地址

审核人员检查项目:

  1. 该文档是否考虑了OWASP书写风格?
  2. 在wiki文档中的内容是否与可下载的文档 (PDF格式和.doc格式)相匹配?
  3. 文档是否包含“关于此文档”章节,以让使用者对文档有大概了解?
  4. 该项发布是如何彻底达到项目的目标的?整个文档是否在结果和组织方面完整?文档是否有缺失部分或没有完成的部分,以至于文档任处于Alpha质量的等级?


文档稳定发布的标准

评估前的检查列表:

  1. 在Alpha和Beta发布中,评估前检查列表中的项目是否全部完成?
  2. 是否记录了一些限制或缺点?
  3. 该文档是否考虑了OWASP书写风格
  4. 是否有一个关于项目发布的文档概览表单?
  5. 文档是否使用了能转换成OWASP书籍的格式?(书籍目前可通过Lulu.com购买)


审核人员检查项目:

  1. 在Beta发布中,审核人员需检查的项目是否都已完成?如果在前一评估阶段没有达到,则必须完成。
  2. 文档是否实质性的解决了当初认为需解决的应用程序的安全问题?
  3. 文档是否遵守了OWASP书写风格?
  4. 你是否发现到一些没有被项目发布领导记录的文档限制或缺点?
  5. 假设在你的工作中有使用该文档的需要,那么你是否会考虑在你的日常工作中使用它?你是否会将该文档推荐给这一领域中的其他人?为什么会?为什么不会?
  6. 如果有的话,缺失哪部分会使这个文档更加有用?缺失的部分,是否会将文档的发布降为Beta等级?