Docstoc

SOP_0401_10 - Code Review SOP

Document Sample
SOP_0401_10 - Code Review SOP Powered By Docstoc
					Title     Code Review SOP
Version   Status                                Date           Page
1.0       Commercial in Confidence              10-Aug-2006    1 of 6




           Code Review SOP




                                     Document No:   SOP_0401
                                     Prepared by:   David Brown
                                     Date:          10-Aug-2006
                                     Version:       1.0
Title         Code Review SOP
Version       Status                                 Date          Page
1.0           Commercial in Confidence               10-Aug-2006   2 of 6



                               Document Approval

Name                    Role             Date          Signature
David Brown             Author




                               Document Control


Version       Author             Date           Description
1.0           David Brown        10-Aug-2001    Version 1
Title              Code Review SOP
Version            Status                                                                    Date                          Page
1.0                Commercial in Confidence                                                  10-Aug-2006                   3 of 6



                                                             Table of Contents



1     Introduction ............................................................................................................................ 4
    1.1      Purpose ........................................................................................................................... 4
    1.2      Scope ............................................................................................................................... 4
    1.3      Definitions ...................................................................................................................... 4
    1.4      Responsibility ................................................................................................................. 4
    1.5      References ...................................................................................................................... 5
2     Code Review Procedure .......................................................................................................... 5
3     Code Review Results Form(s) ................................................................................................ 6
Title     Code Review SOP
Version   Status                                  Date            Page
1.0       Commercial in Confidence                10-Aug-2006     4 of 6




1          Introduction

1.1        Purpose
           To provide guidance for the review of source code developed
           and supported for all validated computer systems.

1.2        Scope
           Department/Section: Information Technology
           Code reviews are required to ensure software has been
           developed to the coding standards and naming conventions
           identified in the Software Development Life Cycle (SDLC).

1.3        Definitions
                  Dead Code – Dead code is program logic that cannot
                   execute because the program path does not permit the
                   logic to be reached. Dead code is non-executable
                   instructions, which are usually artefacts of earlier versions
                   of the program. Code rendered inaccessible by
                   configuration (e.g., switches, parameters, calls, etc.) is
                   not dead code because this code is intended to be
                   available for use dependent on the need of a particular
                   implementation. Code residing in a library, which is not
                   accessed by the calling program, is not considered dead
                   code. Source code that has been “commented out” is not
                   dead code because it is ignored by the compiler and does
                   not become executable instructions.
                  Unit - a program, subprogram, or module that can be
                   described in terms of inputs, processing and outputs.
                  Unit testing - is intended to verify that a program unit
                   ("Unit") performs according to specifications.

1.4        Responsibility
           The group responsible for the development of the source code
           and compilation will conduct code reviews. The code review
           process will be monitored by the validation group.
Title     Code Review SOP
Version   Status                                  Date           Page
1.0       Commercial in Confidence                10-Aug-2006    5 of 6




1.5        References
           Document ID               Title
           SOP_0102                  Document Standards


2          Code Review Procedure
           Source code review must be performed by someone competent
           with regard to the review process and the programming
           language.
           The reviewer must be independent of the program developer.
           Code reviews must be performed on all application program
           source code prior to performing Unit Testing. Programs
           requiring modification after conducting code reviews must have
           a repeat of the code review process before proceeding with Unit
           and System testing.
           The code review must include a review of the source code to
           determine:
                  If the code is an accurate and complete translation of the
                   specification (design review).
                  The absence of dead code.
                  The absence of debugging programming statements such
                   as those that display messages, set input parameters, or
                   set program variables.
                  Adherence to applicable programming standards.
                  Adherence to identified “Software Programming
                   Standards.”
                  Adherence to applicable naming conventions.
                  Adherence to and naming conventions identified in the
                   SDLC used for development.
           During the code review process if any of the above items are
           discovered, they must be corrected prior to performing Unit and
           System Testing of the program. If a justifiable reason exists to
           deviate from this procedure, the justification must be
           documented and reviewed with the validation group for
           resolution.
Title     Code Review SOP
Version   Status                                   Date          Page
1.0       Commercial in Confidence                 10-Aug-2006   6 of 6


3          Code Review Results Form(s)
           The Code Review Results Forms will be prepared according to
           the general format requirements defined in SOP_0102
           "Documentation Standards".
           The Code Review Results Form must contain the following:
                  A record of the design specification(s) used in the review
                   of the unit(s).
                  A record of the program standards used in the review of
                   the unit(s).
                  A record of the naming conventions used in the review of
                   the unit(s).
                  A table with a row for each unit reviewed. Each row will
                   contain:
                      o   The unit identifier
                      o   A description of the unit
                      o   Whether or not the unit complies with the identified
                          specifications and standards
                      o   The date of the review
                      o   Any incident reports arising from the code review
                          process
                      o   The name of the reviewer
                      o   Any comments and observations resulting from the
                          code review process
                  A signature block acknowledging that the reviewer has
                   “reviewed the unit(s) against the specification and
                   standards identified and that the review has been
                   conducted in line with SOP_0401 Code Review”.
                  A signature block acknowledging that all comments and
                   observations have been addressed.

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:10
posted:10/20/2011
language:English
pages:6