Digicorp Code Inspection Process Abhishek Desai

History Michael Fagan developed the formal software inspection process at IBM in the mid 1970s, hence the term "Fagan inspection" . To qualify as a true inspection, the activity follows a specified process and the participants play well-defined roles.

Michael Fagan developed the formal software inspection process at IBM in the mid 1970s, hence the term "Fagan inspection" . To qualify as a true inspection, the activity follows a specified process and the participants play well-defined roles.

Inspection Team 3 – 8 people consisting of following roles Moderator Author Reader Recorder Inspector A person who is not involved in a project but who has the skill set and defect detection abilities should be there as Inspector One person from QA team should also be there as Inspector

3 – 8 people consisting of following roles

Moderator

Author

Reader

Recorder

Inspector

A person who is not involved in a project but who has the skill set and defect detection abilities should be there as Inspector

One person from QA team should also be there as Inspector

Formal Inspection Process Planning Decide the project to inspect Identify critical modules to inspect Overview meeting Not needed if information related to project is known Preparation ( Sample Checklist ) Inspection meeting Max 2 hours Outcome Accepted Accepted with minor revisions Major revisions needed and second inspection required Rework Follow up If more than 10% of project is modified additional inspection may be required Define exit criteria

Planning

Decide the project to inspect

Identify critical modules to inspect

Overview meeting

Not needed if information related to project is known

Preparation ( Sample Checklist )

Inspection meeting

Max 2 hours

Outcome

Accepted

Accepted with minor revisions

Major revisions needed and second inspection required

Rework

Follow up

If more than 10% of project is modified additional inspection may be required

Define exit criteria

Guiding Principles Check your egos at door Critique the product not the producer Find problems during review; don’t fix them Limit inspection meetings to a maximum of two hours Avoid style issues unless they impact performance or understandability Inspect early and often, formally and informally Decide the conventions to inspect Source listing page by page or Call tree

Check your egos at door

Critique the product not the producer

Find problems during review; don’t fix them

Limit inspection meetings to a maximum of two hours

Avoid style issues unless they impact performance or understandability

Inspect early and often, formally and informally

Decide the conventions to inspect

Source listing page by page or

Call tree

Keeping Records Sample issue list Development phase in which error was introduced Severity scale Cosmetic Minor Severe Fatal Describe Error detected in detail Standards violations or style suggestions may apply to the entire product. Summary report

Sample issue list

Development phase in which error was introduced

Severity scale

Cosmetic

Minor

Severe

Fatal

Describe Error detected in detail

Standards violations or style suggestions may apply to the entire product.

Summary report

Reviews and Testing code/inspect/compile/link/test code/compile/inspect/link/test code/compile/link/test/inspect/retest

code/inspect/compile/link/test

code/compile/inspect/link/test

code/compile/link/test/inspect/retest

Notes for Developers/Authors Inspection results will not be used against developers at performance appraisal time. Separate your ego from your work products, everyone do need reviews, you don’t have to become defensive during the inspection meeting. Participants should be prepared adequately prior to the inspection meeting. The items being inspected have to be documented adequately for a reviewer to be able to understand and critique them (this is actually an inspection result in itself). Make sure you are properly trained for the inspection process. Reading this manual is of utmost importance before participation. Author has to take the results of the inspection seriously and make the suggested changes. Inspection meetings should not lose their focus. It should not wander into interesting discussions about technical solutions, and fail to cover the scheduled material. The project schedule should incorporate time for inspections.

Inspection results will not be used against developers at performance appraisal time.

Separate your ego from your work products, everyone do need reviews, you don’t have to become defensive during the inspection meeting.

Participants should be prepared adequately prior to the inspection meeting.

The items being inspected have to be documented adequately for a reviewer to be able to understand and critique them (this is actually an inspection result in itself).

Make sure you are properly trained for the inspection process. Reading this manual is of utmost importance before participation.

Author has to take the results of the inspection seriously and make the suggested changes.

Inspection meetings should not lose their focus. It should not wander into interesting discussions about technical solutions, and fail to cover the scheduled material.

The project schedule should incorporate time for inspections.

Happy Coding!