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. 

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: 

  • Requirements - These influence the design of the software
  • Architecture Documents- These influence the design of the software

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 - Design activities are included in the plan and schedules
  • Software Requirements - These influence the design of the software
  • Software Architecture - These influence the design of the software

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. 

Output Work ProductUsed by Downstream Activity
  • Implementation and Unit Testing
  • Preliminary at Preliminary Design Review
  • Baselined at Critical Design Review
  • Updated at Test Readiness Review
  • Implementation and Unit Testing
  • Preliminary at Preliminary Design Review
  • Baselined at Critical Design Review
  • Updated at Test Readiness Review
  • Implementation and Unit Testing
  • Baselined at Operational Readiness Review

1.4 Successor Activities

Links to Activities which might be started or supported by this activity. 

  • Implementation and Unit Testing - Implements the Design into one or more code modules. 
  • Preliminary Design Review
  • Critical Design Review
  • Test Readiness Review
  • Operational Readiness Review

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
  • Design is always done once. It should be peer reviewed and analyzed by Software Assurance. 
  • Design may be reviewed and re-analyzed as often as there are significant changes in architecture or requirements. For example:  
    • Technology changes to the architecture requires changes to the design
    • Customer changes to requirements require changes to the design

1.6 Center Resources From SPAN

Add links to SPAN activity pages that are appropriate for this activity. Use links from the Activity section of the front page. SPAN

Several Centers Process Asset Libraries have materials related to this activity. Related Processes, templates, and other resources may be found in the following Activities in SPAN (available to NASA only). 


2. Software Development 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.  For each SWE, the related tasks from tab 4 are listed. 

  • Copy of SWE-058 - Detailed Design with new tab 4
    • Tasking
      1. Assess Design Readiness 
      2. Establish Coding Standards and Processes
      3. Establish Project Specific Design Considerations
      4. Establish Detailed Design Documentation and Progress Reviews
      5. Establish Design Maintenance Processes and Mechanisms
    • Work Products
      1. Software Development Process - which includes details on the Design Process to be followed. 
      2. List of design components including when they are expected to be available - as input to Development Schedule
      3. List of methods, tools, standards, and guidelines for your project. 
      4. List of training and experience required by team members to perform the design and development work. 
      5. ....
    • Metrics
      • # of architectural issues, found in peer reviews, identified vs. number closed.
      • # of design issues, from peer reviews, found versus the number of design issues resolved.
      • # of requirement issues (Open, Closed) over time.
      • # of non-conformances identified found versus resolved.
      • # of software work product Non-Conformances identified versus closed.

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 structure pages, PATs, and other relevant pages. 

2.2.1 Topics

2.2.2 Document Structures

2.2.3 Supporting Materials

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. This section may be removed if there is no content for it. 

3. Software Assurance Activity

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 from SWEs

Software Assurance Tasks are included in tab 7 of the SWEs in this activity. 

3.1.1 - Copy of SWE-058 - Detailed Design with new tab 4

    • Tasking From NASA-STD-8739.8B

    • Software Assurance Products
      1. Software Design Analysis
      2. Results of software assurance design analysis, including assessments in Tasks 1, 2, and 3. 
      3. List of any identified design risks and issues.
    • Metrics
      1. # of architectural issues identified vs. number closed.
      2. # of design issues found versus the number of design issues resolved.
      3. # of safety-related requirement issues (Open, Closed) over time.
      4. # of safety-related non-conformances identified by life cycle phase over time.
      5. # of software work product Non-Conformances identified by life cycle phase over time

3.2 Topics and Other Supporting Materials

3.2.1 Topics

3.2.2 Process Asset Templates

3.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. This section may be removed if there is no content for it.