  |
|
Instructions for Software Trouble Report Form
The STR documents all potential software errors. All available information about the problem should be fully and accurately documented or referenced on the STR. The forms are available from the Software Configuration Management (SCM) Manager, and are in the SCM Plan. Please type text or check boxes only in the shaded areas. These shaded areas can be accessed by pressing the TAB key, or placing the cursor on the appropriate area and pressing the left mouse button. The shaded areas marked for text will expand or contract to fit the amount of text that is typed. There is no limit (other than size of page) to the number of words that can be typed in the shaded text areas.
Header Section:
[1] STR Number: Unique STR number.
[2] System/CSCI Name: System or CSCI in which the problem occurs.
[3] Requester’s Name: Person who observes the error and writes the STR. This could be a software tester or anyone using the software system.
[4] Date STR Submitted: Specify the date the STR was submitted.
Section A (Identification of Problem):
[1] Document/Platform/CSCI where problem occurred: Name of the software or document in which the error occurred. If the problem is an execution error, document the platform on which the code was running.
[2] Date discovered: Date the problem was discovered. This could be different than Item [4] in the Header section and might be important in resolving the problem.
[3] Describe the problem: Fully describe the problem or the observed symptom(s), including any possible work arounds. Include how the user is affected, and the problem’s severity. Attach any supporting information that may help in analyzing the problem (e.g., screen image, data files).
[4] Describe the system configuration and software version in which the problem occurred: Provide all information required to accurately describe the software system and the environment in which the problem occurred. This includes all information about the software, hardware, simulator(s), etc.
[5] What were you doing when the problem occurred: Describe the test(s) or sequence of events (e.g. keystrokes) being performed when the problem occurred.
[6] Test Procedure/Test Case No.: If the error was found in qualification testing, identify and describe the test case; otherwise, write the word "None" in the space provided.
[7] Error Discovered by: Check the group reporting the error.
[8] Error Occurrence: If the error is in the code execution, check the box indicating problem frequency. If not, leave blank.
[9] Where did you see this problem: Indicate the site and platform where the error was encountered.
Section B ( Analysis):
[1] Analyzed By: Individual to perform the analysis and the requested completion date (Req. Comp. Date). The individual analyzing the request enters the date the analysis was complete in the Comp Date field.
[2] Source of error (code units(s)) and/or documentation): Identify the error(s) location(s). If no error was found, write "None." If the error was corrected, enter "the error was corrected in Version X.
[3] Software product(s) affected: List all code units and/or documents to be changed if the error is corrected.
[4] Additional problems found during analysis: Document any other potential errors or problems discovered while performing this analysis.
Section C (Resolution)
[1] Action Taken: Determine and document the appropriate action to be taken. If a change in a software product is required, the Project SCM Manager provides an SCR number. If a system-level change is required, the System Configuration Manager provides a CCR number.
[2] Reviewed By/Date: The Project Software Manager signs and dates the STR.