UNDER CONSTRUCTION
Notes in this template provide guidance to authors on how the section if to be completed. Once the section is populated, the Note may be deleted. Notes are not intended to be left in the completed page.
View this section on the website
See edit history of this section
Post feedback on this section
1. Introduction
Typically starts with a quote from the NPR that helps define the activity. Additional descriptive material is meant to help define the activity but not be so detailed that it pulls in all of the guidance from the SWEs in the activity.
Software peer reviews and inspections are the in-process technical examination of work products by peers to find and eliminate defects early in the life cycle. Software peer reviews and inspections are performed following defined procedures covering the preparation for the review, the review itself is conducted, results are recorded, results are reported, and completion criteria is certified. When planning the composition of a software peer review or inspection team, consider including software testing, system testing, software assurance, software safety, software cybersecurity, and software IV&V personnel.
Activity graphical representation of Inputs, Outputs, Predecessor and Successor Activities as appropriate. Not meant to be exhaustive, but representative of a typical project.
1.1 Inputs
List of some of the inputs from other activities that are necessary for the activity to begin.
Examples:
- Planning - Peer Reviews are planned activities. They appear in the plans and schedules for the project
- Requirements - These are the things that are Peer Reviewed
- Architecture Items - These are the things that are Peer Reviewed
- Design items - These are the things that are Peer Reviewed
- Test Plans and Procedures - These are the things that are Peer Reviewed
1.2 Predecessor Activities
List of some of the other activities that must be started (not necessarily completed) so that this activity may begin.
Examples:
Predecessor Activities are performed before Peer Reviews. These activities produce the work products that will be reviewed.
- Life Cycle Planning - plans, schedules, estimates, etc.
- Software Architecture
- Software Design
- Software Testing - plans and procedures
1.3 Outputs
List of some of the outputs or work products of the activity. These are typically used as inputs by the downstream activity. In some cases there is a supporting SWE associated with the work product.
Examples:
The activities that initiated the Peer Review, receive the findings from Peer Reviews, Those activities then use those findings to to fix defects and implement improvements uncovered in the reviews.
| Output Work Product | Used by Downstream Activity |
|---|---|
|
|
1.4 Successor Activities
Links to Activities which might be started or supported by this activity.
1.5 Activity Repetition
Describe what conditions determine if the activity needs to be repeated, such as re-planning after a change in requirements or schedule constraints.
- How much of the activity needs to be repeated
- Frequency of repetition
2. Defining the Activity
This tab contains the links to pages in the SWEHB that are at the heart of the activity.
2.1 SWEs
This section contains the links to SWE pages that form the heart of the activity.
- Link to the SWE goes here
- Excerpt include for the SWE goes here (Remove Surrounding Panel)
2.2 Topics and other Supporting Materials
This section is for SWEHB pages, other than SWEs, that directly support the activity. This section contains Topics, document content pages, PATs, and other pages.
- Link to the Topic or page goes here
- Excerpt include for the Topic or page goes here (Remove Surrounding Panel)
2.3 Other Associated SWEs, Topics, etc.
Includes other SWEHB pages that are indirectly associated with the activity. May include SWEs, Topics, document definition pages, PATs, etc. They may have been mentioned in the guidance of another page.
- Include page for the PAT page goes here
3. Software Assurance
Software Assurance is integral to the performance of all Software Development activities. It includes Process Monitoring as well as Process Analysis.
- Process Monitoring - addresses the question, "Is the development team following their processes and producing the expected work products?"
- Process Analysis - addresses the question, "Are there better ways of performing the processes that would result in the early discovery of defects?"
3.1 Software Assurance Tasks
Software Assurance Tasks are included in many of the SWEs in this activity.
For each of the SWEs in this activity (see tab 2 .1 SWEs) populate the table below with the SWE, Requirement, and SA Tasks.
- The first column is for the SWE number
- The second column is for the requirement - using the Excerpt Include macro to pull in the Excerpt from the SWE page (excerpt includes the text of the requirement)
- The third column is for the SA Tasks using the Include Page macro - Each of the SA Tasks for a SWE are child pages under SITE:NASA-STD-8739.8B page
| SWE | Requirement | SA Tasks |
|---|---|---|
034 | Error rendering macro 'excerpt-include' No link could be created for 'SWE-034 - Acceptance Criteria'. | 1. Confirm software acceptance criteria are defined and assess the criteria based on guidance in the NASA Software Engineering Handbook, NASA-HDBK-2203. |
