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 20

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. 

  • 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

SPANAdd 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). 

Tabsetup
01. Introduction
12. Software Development ActivityEngineering
23. Software Assurance Activity
List of some of the inputs from other activities

Documents that are necessary for

the activity

Design to begin

.

: 

Examples: 

1.2 Predecessor Activities

note

Examples: 

Predecessor Activities are performed before Peer ReviewsDesign. These activities produce the work products that will be reviewed. 

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. 


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 4.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. 

1.1 Inputs

Note

List of some of the other activities that must be started (not necessarily completed) so that this activity may begin. 

Note
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

Note

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

note

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
Note
ActivityDescription

Design

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

6.3 - Checklist for Choosing a Real Time Operating System (RTOS)
Div
idtabs-2

2. Software

Development Activity
Note

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

Engineering

2.1 SWEs

Note

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. 

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

  • Assess Design Readiness 
  • Establish Coding Standards and Processes
  • Establish Project Specific Design Considerations
  • Establish Detailed Design Documentation and Progress Reviews
    • Establish Design Maintenance Processes and Mechanisms

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

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

    2.2 Topics and other Supporting Materials

    Note
    Expand
    titleSWE-058 Topics

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

    Excerpt IncludeSWEHBVD:6.3 - Checklist for Choosing a Real Time Operating System (RTOS)SWEHBVD:6.3 - Checklist for Choosing a Real Time Operating System (RTOS)nopaneltrue6.4 - Checklist for Choosing Off-The Shelf Software (OTS) Excerpt IncludeSWEHBVD:6.4 - Checklist for Choosing Off-The Shelf Software (OTS)SWEHBVD:6.4 - Checklist for Choosing Off-The Shelf Software (OTS)nopaneltrue

    2.2.2

    Document StructuresSwDD - Software Design Description  Excerpt IncludeSWEHBVD:SwDD - Software Design DescriptionSWEHBVD:SwDD - Software Design Descriptionnopaneltrue
  • Preliminary at PDR - 7.9 - Entrance and Exit Criteria (tab 7)
  • Baselined at CDR - 7.9 - Entrance and Exit Criteria (tab 8)
  • Updated at TRR - 7.9 - Entrance and Exit Criteria (tab 11)
    • IDD - Interface Design Description Excerpt IncludeSWEHBVD:IDD - Interface Design DescriptionSWEHBVD:IDD - Interface Design Descriptionnopaneltrue
  • Preliminary at PDR - 7.9 - Entrance and Exit Criteria (tab 7)
  • Baselined at CDR - 7.9 - Entrance and Exit Criteria (tab 8)
  • Updated at TRR - 7.9 - Entrance and Exit Criteria (tab 11)
    • SUM - Software User Manual Excerpt IncludeSWEHBVD:SUM - Software User ManualSWEHBVD:SUM - Software User Manualnopaneltrue
  • Baselined at ORR - 7.9 - Entrance and Exit Criteria (tab 13)

    • 2.2.3 Supporting Materials

    Software Design Principles Excerpt IncludeSWEHBVD:Software Design PrinciplesSWEHBVD:Software Design Principlesnopaneltrue Include PageSWEHBVD:Principles TableSWEHBVD:Principles Table

    2.3 Other Associated SWEs, Topics, etc.

    NoteIncludes 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. 

    Supporting Materials

    Expand
    titleSWE-058 Supporting Materials

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

    2.3 Other Associated SWEs, Topics, etc.


    PAT-023 - Preparing for a SARB ChecklistPAT-031 - Critical Design Analysis Checklist

    excerpt-

    Div
    idtabs-3

    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

    SWE-058 - Detailed Design with new tab 4

    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

    Software Assurance

    SA Work Products

  • Software Design Analysis
  • Results of software assurance design analysis, including assessments in Tasks 1, 2, and 3. 
  • List of any identified design risks and issues.
    • Metrics

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

  • # of architectural issues identified vs. number closed.
  • # of design issues found versus the number of design issues resolved.
  • # of safety-related requirement issues (Open, Closed) over time.
  • # of safety-related non-conformances identified by life cycle phase over time.
    • # of software work product Non-Conformances identified by life cycle phase over time

    3.2 Topics and Other Supporting Materials

    3.2.1 Topics

    • Topic 8.16 - 8.55 - Software Design Analysis
      • Excerpt Include
        SWEHBVD:8.55 - Software Design Analysis
        SWEHBVD:8.55 - Software Design Analysis
        nopaneltrue
        SA Tasks for SWEs
    Expand
    titleSA Tasking from Topic 8.16 - Software Design Analysis

    3.2.2 Process Asset Templates

    PAT-021 - SADESIGN Checklist
    Excerpt Include
    PAT-021 - SADESIGN ChecklistPAT-021 - SADESIGN Checklist
    nopaneltrue
    Excerpt Include
    PAT-023 - Preparing for a SARB ChecklistPAT-023 - Preparing for a SARB Checklist
    nopaneltrue
    Include Page

    PAT-031 - Critical

    Design Analysis

    ChecklistPAT-031 - Critical Design Analysis ChecklistnopaneltruePAT-008 - Safety Considerations for Design Peer Reviews Checklist Excerpt IncludePAT-008 - Safety Considerations for Design Peer Reviews ChecklistPAT-008 - Safety Considerations for Design Peer Reviews ChecklistnopaneltruePAT-020 - Examples of Interface Problems

    Process Asset Templates
    Design Analysis Process Asset Templates

    Excerpt IncludePAT-020 - Examples of Interface ProblemsPAT-020 - Examples of Interface Problemsnopaneltrue

    3.3 Other Associated SWEs, Topics, etc.

    NoteIncludes 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. 





    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
    ______________________________________________________________________________