Check Lists:Quality Management/Peer review: Difference between revisions
Jump to navigation
Jump to search
(Created page with "Peer review is used to enhance the quality of software code and documentation. When a peer review is performed it is the product (code or document) that is reviewed - not the aut...") |
No edit summary |
||
| Line 5: | Line 5: | ||
==Code review check list== | ==Code review check list== | ||
* Check that the file complies with the documentation standard. See more: [[QM:Quality_manual/Procedures/Control_of_documents#Software code control|Documents control]] | * Check that the file complies with the documentation standard. See more: [[QM:Quality_manual/Procedures/Control_of_documents#Software code control|Documents control]] | ||
* Check that the appropriate coding standard has been followed: Eg. [[QM:Quality_manual/Work_instructions/JavaScript_coding_standard|JavaScript coding standard]] / [[QM:Quality_manual/Work_instructions/PHP_coding_standard|PHP coding standard]]. | |||
* Check for logical errors. | |||
* Suggest enhancement where appropriate. | |||
==Document review check list== | ==Document review check list== | ||
more to come.. | more to come.. | ||
| Line 11: | Line 16: | ||
* [[QM:Quality_manual/Work_instructions/JavaScript_coding_standard|JavaScript coding standard]] | * [[QM:Quality_manual/Work_instructions/JavaScript_coding_standard|JavaScript coding standard]] | ||
* [[QM:Quality_manual/Work_instructions/PHP_coding_standard|PHP coding standard]] | * [[QM:Quality_manual/Work_instructions/PHP_coding_standard|PHP coding standard]] | ||
* [[QM:Quality_manual/Procedures/Control_of_documents#Software code control|Control of documents, Software code control]] | |||
==Document History== | ==Document History== | ||
Latest revision as of 13:34, 26 October 2011
Peer review is used to enhance the quality of software code and documentation. When a peer review is performed it is the product (code or document) that is reviewed - not the author of the product!
It takes training both for the reviewer and for the author: As the author, you have to focus on purpose of the review: Enhancement of the product! Try to use the comments you receive constructively. In the process of enhancing the product you may also lean something new.
Code review check list
- Check that the file complies with the documentation standard. See more: Documents control
- Check that the appropriate coding standard has been followed: Eg. JavaScript coding standard / PHP coding standard.
- Check for logical errors.
- Suggest enhancement where appropriate.
Document review check list
more to come..
References
Document History
| Version | Date | Author | Status | Purpose of update |
|---|---|---|---|---|
| 1 | 26 Okt 2011 | PSA | Draft | New document. |