bannerd

A. Introduction

B. Institutional Requirements

C. Project Software Requirements

D. Topics

E. Tools, References, and Terms

F. SPAN
(NASA Only)

Versions Compared

Old Version 1

changes.mady.by.user Haigh, Fred

Saved on

compared with

New Version Current

changes.mady.by.user Haigh, Fred

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

UNDER CONSTRUCTION


Note

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. 


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. 

Tabsetup
01. Introduction
12. Defining the ActivitySoftware Engineering
23. Software Assurance
List of some of the inputs from other activities

Documents that are necessary for

the activity

Design to begin

.

: 

Examples: 

  • SRS - Software Requirements Specification  - Requirements - These influence the design of the software
  • 5.13 - SwDD - Software Design Description- Contains Architecture description - This influences the design of the software
  • 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

Div
idtabs-1

1. Introduction

Note

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. 


Panel
borderColorblue
titleNPR 7150.2B para 54.3.1

Include Page
2D-Para 4.3.1
2D-Para 4.3.1
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.

Panel
borderColorblack
borderWidth2
titleInputs, Outputs, and Predecessor Related Activities

Activity graphical representation of Inputs, Outputs, Predecessor and Successor Activities as appropriate. Not meant to be exhaustive, but representative of a typical project. 

 

Image Added

1.1 Inputs

Note
Note

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 ReviewsDesign. These activities produce the work products that will be reviewed. 

  • Life Cycle Planning - plans, schedules, estimates, etc.
  • Software Architecture 
  • Software Design
  • 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 softwareSoftware Testing - plans and procedures

1.3 Outputs

note

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. 

  • Life Cycle Planning
  • Software Architecture 
  • Software Design
  • Software Testing
  • Configuration Management
    • Coding
    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
    • Peer Review Findings

    1.4 Successor Activities

    NoteLinks 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

    Note

    Describe what conditions determine if the activity needs to be repeated, such as re-planning after a change in requirements or schedule constraints. 

    • 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
  • How much of the activity needs to be repeated
    • Frequency of repetition

    1.6 Center Resources From

    SPAN NoteAdd 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). 

    Project Planning

    ActivityDescription

    Design

    		Assets for use during product design
    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


    Div
    idtabs-2

    2.

    Defining the Activity
    Note

    This tab contains the links to pages in the SWEHB that are at the heart of the activity. 

    2.1 SWEs

    Note

    This section contains the links to SWE pages that form the heart of the activity. 

    Link to the SWE goes hereExcerpt include for the SWE goes here (Remove Surrounding Panel)

    Software Engineering

    2.1 SWEs

    SWE-058 - Detailed Design with new tab 4

    Expand
    titleSWE-058 Tasking and Work Product Details

    Link to SWE-058 - Copy of SWE-058 - Detailed Design with new tab 4

    Class Applicability: A B C

    SWE-058 Requirement

    Excerpt Include
    Copy of SWE-058 - Detailed Design with new tab 4
    Copy of SWE-058 - Detailed Design with new tab 4
    nopaneltrue

    Include Page
    SWE-058-ETask
    SWE-058-ETask

    Include Page
    SWE-058-EWP
    SWE-058-EWP

    2.2 Topics and other Supporting Materials

    Note

    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. 

    2.2.1 Topics

    Expand
    titleSWE-058 Topics

    Include Page
    SWE-058-ETopics
    SWE-058-ETopics

    2.2.2 Supporting Materials

    Expand
    titleSWE-058 Supporting Materials

    Include Page
    SWE-058-ESupport
    SWE-058-ESupport

    Link to the Topic or page goes hereExcerpt include for the Topic or page goes here (Remove Surrounding Panel)

    2.3 Other Associated

    SWEs, Topics, etc.
    Note

    SWE-058 - Detailed Design with new tab 4

    Div
    idtabs-3

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

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

    Note

    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-034 is used below only as an example of how to populate the table. The example below, using SWE-034, should be replaced by the actual SWEs in this activity. 

    SWERequirementSA Tasks
    Expand
    titleSWE-058 SA Tasking and Work Product Details

    Link to SWE-058 - Copy of SWE-058 - Detailed Design with new tab 4

    SWE-058 Requirement

    Excerpt Include
    Copy of SWE-058 - Detailed Design with new tab 4
    Copy of SWE-058 - Detailed Design with new tab 4
    nopaneltrue

    Tasking From NASA-STD-8739.8B

    Include Page
    SWE-058 - SA Task1
    SWE-058 - SA Task1

    Include Page
    SWE-058 - SA Task2
    SWE-058 - SA Task2

    Include Page
    SWE-058 - SA Task3
    SWE-058 - SA Task3

    Include Page
    SWE-058 - SA Task4
    SWE-058 - SA Task4

    Include Page
    SWE-058 - SA Task5
    SWE-058 - SA Task5

    SA Work Products

    Include Page
    SWE-058-SAWP
    SWE-058-SAWP

    3.2 Topics and Other Supporting Materials

    3.2.1 Topics

    Expand
    titleSA Tasking from Topic 8.16 - Software Design Analysis

    3.2.2 Process Asset Templates

    Include Page
    Design Analysis Process Asset Templates
    Design Analysis Process Asset Templates

    3.3 Other Associated SWEs, Topics, etc.

    034

    Excerpt IncludeSWEHBVD:SWE-034 - Acceptance CriteriaSWEHBVD:SWE-034 - Acceptance Criterianopaneltrue Include PageSWE-034 - SA Task1SWE-034 - SA Task1





    Page Editor: Tim Crumbley
    NASA Official: Tim Crumbley
    Accessibility
    NASA Software Engineering Handbook - A service of the NASA Office of the Chief Engineer
    NASA Privacy Statement
    ______________________________________________________________________________