Desk Check Kit

Version 1

Content

Activities for: Author, reviewer

Checklist: Generic

Form: Desk check form

Goal. To find defects, omissions, and contradictions; to improve the product; and to consider alternative implementations.

Note: When the document is larger than 20 pages, it is recommended to iterate between document generation and review activities in order to detect and correct errors as soon as possible.

ENTRY CRITERIA

  • None

INPUT

  • Document to be reviewed

ACTIVITIES

  1. Author
  2. Completes the upper part of the Desk check Review Form:
  • Name of author, date, document title, document version, name of reviewer(s).
  • Distributes to selected reviewer(s) the document to be reviewed and:
  • Desk check Review Form(s)
  • Checklist(s) (if applicable)
  1. Reviewer(s)
  2. Verify the document using the checklist(s) selected by the author
  3. Fill-in the Desk Check Review Form (i.e. comments and effort taken to review the document)
  4. Forward Review Form to the author.
  1. Author
  2. Review the comment(s) documented on the Review Form(s)
  3. If author agrees with all the comment(s), he incorporates them in the document.
  4. If the author does not agree on comments, or if he thinks that comments have major impact on the document:
  5. Calls a Review meeting.
  6. Conducts the Review meeting to finalize the disposition of comments as follow:
  7. Incorporate as is
  8. Not incorporate
  9. Incorporate with modifications
  10. Author incorporates comments in the document.
  11. Author logs on the Desk check review form the effort required to correct the document

EXIT CRITERIA

  • Document has been corrected.

OUTPUT

  • Document corrected
  • Review Form completed

MEASURE

  • Effort to review and correct the document (staff-hours)

Checklist

Generic Document Checklist

These rules specify the requirements that must be satisfied by any document that is subject to inspections.

  • GD1 (COMPLETE). All information relevant to the purpose of the document must be included or referenced.
  • GD2 (RELEVANT). All information must be relevant to the purpose of the document and the section in which it resides.
  • GD3 (BRIEF). Information must be stated succinctly.
  • GD4(CLEAR). Information must be clear to all checkers.
  • GD5(CORRECT). Information must be free of technical errors.
  • GD6(CONSISTENT). Information must be consistent with all other information in the document and its source documents.
  • GD7(UNIQUE). Ideas should be stated once only and thereafter referenced.
  • GD8(REFERENCE). References must be cited for non-original or derived statements.
  • GD9(COMMENT). All form of comment, note, suggestion, or idea that does not form an official part of the document must be clearly distinguished as such.

Desk Check Review Form

Name of author: ______Date (YYYY-MM-DD):______

Document Title:______/ ______/ ______/ Name of Reviewer: / ______
Document Version:___ / ______
Comment No. / Document Page / Line Number / Location / Comments / Disposition of comments * / Remarks
1
2
3
4
5
6
7
8

Effort to review document: ______

Effort to correct document: ______

* Disposition: Inc: Incorporate as is; NOT: Not incorporate, MOD: Incorporate with modification