Interactive collaborative facility for inspection and review of software products

• US 7,386,831 B2
• Filed: 01/09/2002
• Issued: 06/10/2008
• Est. Priority Date: 01/09/2002
• Status: Expired due to Fees

• Current Assignee: Unify Inc. (Atos SE)
• Original Assignee: Siemens Communications Incorporated (Siemens AG)
• Inventors: Flanagan, Mark J.
• Primary Examiner(s): An, Meng-Ai T.
• Assistant Examiner(s): To, Jennifer N.
• Application Number:
  US10/042,616
• Publication Number:
  US 20030131313A1
• Time in Patent Office: 2,344 Days
• Field of Search: 717100-103, 715500-530, 715751-753, 705/11, 705/80, 709/204
• US Class Current: 717/103
• CPC Class Codes: G06F 8/75 Structural analysis for program understanding
• CPC Class Codes: G06Q 10/10 Office automation; Time management

Abstract

A review facility and review method for interactively reviewing an item, such as a block of code, by a group of reviewers and collecting comments from the reviewers. An author provides the item as text for preparation for interactive review. The text is prepared, tagging each line and making the tagged text available to reviewers, e.g., as links on a web page. Reviewers interactively comment on individual lines and review previously entered comments. An abbreviated formal review may follow the interactive review.

Claims

1. A review facility having a processor for providing a document for collaborative review by a plurality of reviewers and collecting comments from reviewers, said review facility comprising:

preparation means for preparing software source code for interactive collaborative review comprising;

selection means for selecting and retrieving said software source code, and

means for formatting said retrieved software source code and building a comment file, wherein the means for formatting said software source code identifies individual lines of said source code within said software source code, said interactive collaborative review providing comments on ones of said individual lines of said source code;

means for making said prepared software source code available for interactive collaborative review, said prepared software source code being independently reviewable in said interactive collaborative review;

means for collecting comments on said individual lines of said source code in said prepared software source code from said interactive collaborative review, collected comments on code lines being contained in said comment file;

means for distributing collected said comments from said interactive collaborative review; and

means for conducting a formal review, wherein distributed said comments sufficiently provide any collaborating reviewers attending a subsequent formal review meeting with awareness of a particular condition with respect to said interactive collaboratively reviewed said software source code that said comments may be addressed in said interactive collaborative review prior to said formal review meeting, such that further action is unnecessary at the time of said formal review with respect to said particular condition and each corresponding said comment.

2. A review facility as in claim 1 wherein the means for collecting comments comprises:

means for providing said software source code to collaborating reviewers; and

reviewer selection means for selecting said software source code for review responsive to reviewer selection.

3. A review facility as in claim 1, wherein said means for distributing collected said comments makes collected said comments available for further interactive collaborative review, and said review facility further comprises:

means for presenting for consideration collected comments from said interactive collaborative review, said collected comments being previously distributed by said means for distributing collected comments to identified collaborating reviewers participating in a formal review.

4. A method of reviewing a document being prepared for distribution, said method comprising the steps of:

a) preparing source code for interactive review, preparing said source code comprising the steps of;

i) retrieving said source code for review, and

ii) formatting said source code and building a comment file, individual blocks of text being identified for comment in said formatted source code, individual lines of source code being identified for comments;

b) making said prepared source code available for said interactive review and receiving comments on said prepared source code from said interactive review, comments provided on said lines of source code being contained in said comment file; and

c) conducting a formal review meeting of said interactively-reviewed source code with a plurality of reviewers, whereby one or more of the previously provided said comments sufficiently provides attending reviewers awareness of a particular condition with respect to said interactively-reviewed source code that said comments may be addressed in said interactive review prior to said formal review meeting, such that further action is unnecessary at the time of said formal review with respect to said particular condition and each corresponding comment.

5. A method as in claim 4 wherein each occurrence of said interactive review in the step (b) of making the prepared source code available comprises the steps of:

i) selecting said source code;

ii) reviewing comments on said selected source code;

iii) determining whether said selected source code warrants additional comments;

iv) distributing warranted additional comments on said selected source code; and

v) repeating steps (i-iv) until all documents for review have been selected.

6. A method as in claim 5 wherein source code is stored in a central repository and the step (i) of selecting said source code comprises connecting over the Internet to said central repository and accessing said source code.

7. A method as in claim 4 wherein returned said comments are available for display upon receipt.

8. A computer program product for presenting a software source code block for collaborative review by a plurality of reviewers and collecting comments from reviewers, said computer program product comprising a computer usable medium having computer readable program code thereon, said computer readable program code comprising:

computer program code means for preparing a source code block for collaborative review comprising;

computer program code selection means for selecting and retrieving said source code block, and

computer program code means for formatting retrieved source code blocks and building a comment file, individual lines of said source code being identified within said source code block;

computer program code means for collecting comments from said collaborative review collected comments on code lines being contained in said comment file;

computer program code means for distributing collected comments to reviewers identified for attendance at a subsequent formal review meeting, reviewers providing comments on ones of said individual lines, wherein distributed said comments sufficiently provide any identified said reviewers with awareness of a particular condition with respect to said interactive collaboratively reviewed source code blocks that said comments may be addressed in said interactive collaborative review prior to said formal review meeting, such that further action is unnecessary at the time of said formal review with respect to said particular condition and each corresponding comment; and

computer program code means for providing distributed comments for said formal review.

9. A computer program product as in claim 8 wherein the computer program code means for collecting comments comprises:

computer program code means for providing source code block to reviewers; and

computer program code means for selecting said source code block for review responsive to reviewer selection.

10. computer-readable medium having stored thereon a plurality of instructions, the plurality of instructions including instructions which, when executed by a processor, cause the processor to:

a) prepare source code for interactive review and further causing the processor to;

i) selectively retrieve said source code for review, and

ii format said source code and building a comment file, individual said lines of source code being identified for comment in said formatted source code;

b) make said prepared source code available to a plurality of interactive reviewers for interactively commenting on said Lines of source code;

c) receive comments from ones of said plurality of interactive reviewers, received comments being contained in said comment file; and

d) present said source code and received said comments for a formal review meeting, whereby one or more-of the previously provided comments sufficiently provides attending reviewers awareness of a particular condition with respect to said source code that said comments may be addressed in said source code prior to said formal review meeting, such that further action is unnecessary at the time of said formal review with respect to said particular condition and each corresponding comment.

11. A computer readable medium as in claim 10 wherein source code is located in a central repository and the step i) of selectively retrieving said document causes the processor to connect over the Internet to said repository and access said source code.