bannera

Book A.
Introduction

Book B.
7150 Requirements Guidance

Book C.
Topics

Tools,
References, & Terms

SPAN
(NASA Only)

This version of SWEHB is associated with NPR 7150.2A. This version has been superseded by SWEHB Version A.  The SWEHB Version A is based on NPR 7150.2B 
Click to go to the SWEHB Version A based on NPR7150.2B Use the links in tab 5 to navigate to other versions of the SWEHB. 


Book A. Introduction

NASA-HDBK-2203.

Software is a core capability and key enabling technology for NASA's missions and supporting infrastructure. 

This wiki-based NASA Software Engineering and Assurance Handbook, NASA-HDBK-2203 provides users and practitioners with guidance material for implementing the requirements of NPR 7150.2, NASA Software Engineering Requirements, and the implementation of the NASA Software Assurance and Software Safety requirements in NASA-STD-8739.8 278. The requirements in this directive and standard have been extracted from industry standards and proven NASA experience in software engineering. 

The NASA Software Engineering and Assurance Handbook, NASA-HDBK-2203 is for the community that is involved in the acquisition, management, development, assurance, maintenance, and operations of NASA software. The use of this handbook is intended to provide "best-in-class" guidance for the implementation of safe and reliable software in support of NASA projects.

The NASA Software Engineering and Assurance Handbook, NASA-HDBK-2203 as an easily accessible reference or manual that captures the broad knowledge base of numerous experts who have extensive experience in all aspects of NASA's software systems. The handbook is a key component of an Agency-wide plan to work toward a continuous and sustained software engineering and software assurance process and product improvement.

(Contact the SWEHB site admin for resolution of technical difficulties.)

The NASA Software Engineering Requirements, NPR 7150.2A, can be viewed at https://swehb-pri.msfc.nasa.gov/download/attachments/16450019/N_PR_7150_002A_.pdf?api=v2 275 archive

The old version of the NASA Software Assurance Standard requirements, NASA-STD-8739.8, can be viewed at 

https://swehb-pri.msfc.nasa.gov/download/attachments/16450326/nasa-std-8739.8.pdf?api=v2 308 archive

The old version of the NASA Software Safety Standard requirements, NASA-STD-8719.13C, can be viewed at 

https://swehb-pri.msfc.nasa.gov/download/attachments/16450126/nasa-std-8719.13c_0.pdf?api=v2 271 archive

SWEHB Introduction

The NASA Software Engineering Handbook (SWEHB) originated from multiple requests for additional guidance, rationale, resources, references and lessons learned for acquiring, managing, developing, assuring and maintaining NASA software systems. The design of the electronic (wiki-based) format was selected to accommodate the following evolving needs:

  • To publish material in a timely fashion.
  • To provide needed information in concise screen-friendly chunks.
  • To simplify updates to the Handbook.
  • To make it easily searchable.
  • To engage the NASA software community by providing an easy-to-use vehicle for
    • providing feedback,
    • sharing examples of best practices, and
    • contributing lessons learned developed on their own projects.

The SWEHB is accessible on the NASA Engineering Network(NEN) 258. The Agency's software community will find they have complete and speedy access to all written content and reference links in the Handbook through the NEN. Numerous important links are also provided for relevant processes, templates, and tools in the NASA Process Asset Library (PAL).

The SWEHB wiki can be used in a similar manner to the use of hard copy guidebooks, but it offers significant advantages for the reader. Once a general familiarity with the resource is obtained, the user will be able to directly access concise information relevant to their interest or need. (Typically a quick scan and flip through the Handbook structure, including the chapter organization and the reference/appendix material, is enough to gain familiarity.)

Users are encouraged to provide general feedback on the SWEHB by using the "Comments" box found on the wiki pages. Suggestions for improvements, identification of errors, and proposed additions to the SWEHB are all welcome. The SWEHB Development Team will review and disposition comments received. Additions, if approved for posting by the SWEHB editor, will be added via incremental updates.

The SWEHB provides guidance associated with each SWE (Software Engineering Requirement). Software developers take note - Only general approaches for Agency use are provided in the information in these essays. Users are expected to consult NASA Center resources for local procedures and guidance, when available.

The Software Engineering Handbook is available on the NEN from the Software Engineering Community of Practice 435 homepage. This site offers additional guidance and information to software developers, including the Ask an Expert 436 pick, a Contact List 435, a Classification Tool, a Document Repository 437, and much more. Frequent users may wish to add a direct bookmark to the SWEHB in their browser <https://swehb.nasa.gov>.

Here's an overview of each Book within the SWEHB:

  • Book A contains the Introduction.
  • Book B contains the developed guidance for each SWE. (Note that the SWE descriptions are organized into six chapters within Book B that mirror the organization of NPR 7150.2). The SWEs are presented in nominal ascending numerical order, with some higher-numbered SWE intermixed. These latter SWE represent the changes made between the NPR 7150.2 and the NPR 7150.2A revisions. The SWEHB was written so that each SWE guidance section provides stand alone explanations and interpretive information about the implementation of requirement. To enhance the usefulness of each module, the guidance includes hyperlinks for easy reference to related SWEs and Topics.
  • Book C contains special Topics, most in the form of essays, that are broader than any single SWE. Many of the special Topics take the form of "how to" and instructional material for users seeking to improve their knowledge and practices in software engineering. It is expected that the special Topics will help the user go beyond the minimum descriptions presented in each SWE. Topics are more expansive on particular ideas and contain additional instructions for developing and acquiring software. Note: Book A. Introduction includes the definitions of terms from the Appendix A of the NPR 7150.2.
  • Book D lists the current tags (labels) that are used throughout the Handbook. To further assist the user in finding needed and useful information, a "tag" system has been developed using the SMARTS Tagging approach to indicate relationships between or among individual ideas contained within multiple SWEs. The tagging search feature in Book D allows both individual and multiple tag searching. Tag searches provide an additional way for users to browse and discover content within the Handbook. The terms "tag" and "label" are used interchangeably in the Handbook.
  • Book E contains a list of terms including acronyms and/or definitions that are used in the handbook, listings of and references to software development tools that are used around the Agency, and a complete listing of Handbook references in a numerated References Table.

Explanation of the SEARCH Box in the splash banner above: This utility allows the SWEHB user to interrogate the Handbook contents for particular items of interest.

Tag searches are performed using the search tool in Book D.

In the SWEHB a typical SWE essay has six sections;

  • THE REQUIREMENT: This section is a restatement of the NPR 7150.2 requirement wording, including any Notes from either the requirement paragraph itself, or any applicable note from Appendix D. This section also gives a tabular representation of the applicability to each software class 438.

    The text in this section can only be altered via an approved change request and NODIS update of NPR 7150.2.

  • RATIONALE: This section provides useful information regarding the purpose of the requirement. Occasionally, historical information and or references are included to further support the rationale statement.
  • GUIDANCE: This section provides information helpful for interpreting the requirement, its scope, its relationship to other SWE, associated best practices, and references to supporting materials (standards, guides, published technical papers, the NEN 258 and the NASA PAL 266 materials).
  • SMALL PROJECTS: This section suggests implementation aids to small projects to help satisfy the SWE while accommodating the typically limited resources of time, funds, and personnel. The definition of "small project" needs to be determined by the user.

    This determination does not relieve a project from satisfying the requirements in the NPR.

    When small projects need to reduce the set of applicable software requirements due to constraints, the designated Center Software Technical Authority is to be consulted. Waivers and Deviations against NASA requirements are broadly covered in NPR 7120.5 082, section3.3, and specifically covered for software in Chapter 6 of NPR 7150.2 (with associated guidance in this Handbook). NASA Chief Engineer’s specific direction on waivers and Technical Authority is located on the NASA Engineering Network (NEN). 262 NODIS maintains a web page 406   for the posting of approved waivers for general reference.

  • RESOURCES: This section provides a listing of referenced and footnoted texts, documents found within NASA repositories and/or out on the web, and other useful documents (e.g., checklists and/or templates). It is instructive to note that the Handbook authors also included in the Resources sections listings of what might be best described as "additional reading", i.e., useful items not specifically cited or linked to in the GUIDANCE section, but thought by the authors to contain educational or expanded discussions of the ideas covered in the SWE write-up.

    Also, this section usually includes a separate table listing of tools, items that will help the user satisfy the requirement (e.g., developer tools). The Handbook wiki links SWEs and tools through the use of a master Tools table. The Tools table provides web sites for accessing the tool. It also lists Center(s) that currently use the tool in case the reader wants to seek out the "experiences" of a current user of the tool. Readers are invited to submit their tools for candidate inclusion in the Tools table for the benefit of others around the Agency.
  • LESSONS LEARNED (LL): This section contains references to the experiences of others involved in NASA software development activities as well as other industry and government development efforts. The majority are catalogued in the Public Lessons Learned library 439at the Office of the Chief Engineer (OCE). 440Some are derived from specialized project or Center collections as well as from reputable industry and government groups. Occasionally a lesson has only indirect applicability to the requirement. It is presented as a related lesson that can be applied to help understand the content of the SWEHB.

Remember that the NPR 7150.2 is a requirements document. It uses "shall" exclusively to indicate requirements. Applicability of a NPR 7150.2 requirement is determined by NASA Software Classification and the matrix in Appendix D (of the NPR). The SWEHB is not a requirements document, only an informational document. NO new requirements are added by the SWEHB. The authors strove to exclude the use of "shall" and "should" in any paragraph that might be interpreted as a requirement or even an augmentation to a requirement.

The NPR 7150.2 made extensive use of the NPR's Notes sections to help with the interpretation of the SWE. This Handbook is intended to collaborate with and to augment the NPR's Notes.

The Requirements Mapping Matrix (RMM)in NPR 7150.2 443 provides a list of the applicability of each requirement by the Class of software being developed. Associated with many of the entries in the RMM are one or more notes that modify the applicability of the requirement for a particular Class. Since the SWEHB makes explicit mention of these modifiers in section 1 of the SWE essay, an additional explanation for each note is included here:

  • The "X" notation signifies that the full requirement (assuming "no exceptions") is applicable to the software. Note that requirements labeled with an "X" can still be tailored with the appropriate approvals, or otherwise affected by approved deviations and or waivers.
  • The "SO" (i.e., Safety Only) designation signifies that the requirement for the classification of software needs only to satisfy the safety aspects of the requirement. This may require the use of checklists (e.g., use of the "litmus test") in NASA STD 8739.8 NASA Software Assurance Standard 278 and NASA STD 8719.13 Software Safety Standard 271 to determine specifically what parts of the project, its software, and therefore the requirement, are applicable to ensure the development of safe software.
  • The "P (Center)" designation, while amply described in Book A. Introduction, is used separately or in combination with the "SO" modifier. The "P (Center)" modifier is only applicable to the items of the requirement that do not incur a "safety-critical" designation. The interpretation is consciously left to the individual Center Technical Authorities since they and their individual projects are unique, and this tends to make one universal applicable statement too inexact.

Some general comments:

  • Note that the SWE titles in the SWEHB may not always agree with those in the NPR. The SWEHB Development Team expanded the titles for some of the SWE to help distinguish between other similarly sounding SWE names (e.g., "bidirectional traceability").
  • Much of the referenced material listed in the Resources section is located on the NASA Headquarters NODIS site, e.g., NPR's, NPD's; in the Agency PAL, e.g., materials from the OCE, Public LLs; or in the NASA Technical Standards (START)repository 442, e.g., NASA standards, IEEE standards, etc. Please note that many of these Agency or Center assets are subject to scheduled updates. While we will make every effort to link to the latest versions, editions or documents, it is possible that you will discover references that have broken links or require updating. We invite the community to submit these directly to the Handbook Development Team using the "Comments" box located at the bottom of each Handbook page.
  • Extensive citations are also made to external sites (e.g., Hill Air Force Base at the Software Technology Support Center (STSC) 441, Software Engineering Institute (SEI) 157) and to general web-hosted sites. While attempts were made to cite publically available (i.e., "free") references, there may be an occasional reference that suggests the reader "buy" a copy. If you come across one of these, try to access it through the NASA START (technical standards) 442 site. A simple and quick one-time registration is required. This NASA site provides prepaid access to many external repositories through an Agency wide agreement with the site.
  • (Caveat: Since the web is a dynamic place, some references in the Resources section of the SWE may have been discontinued online or moved to another host by their owners.  While all references have been verified on internal Agency networks as well as external Virtual Private Network (VPN) access, the variances in firewall and VPN settings, permissions, and configurations may affect access to these references.)

Each page of the SWEHB has a "Comments" box to allow feedback and proposed inputs, revisions, and updates to the Handbook. The SWEHB Development Team requests comments on errors, inputs on real or perceived conflicts among the essays within the SWEHB and suggestions for additional material such as best-in-class examples, templates, tools or Lessons Learned (LL) entries.

Title Material

NASA TECHNICAL HANDBOOK

National Aeronautics and Space Administration

Washington, DC  20546-0001

NASA Software Engineering Handbook

NASA-HDBK-2203

Approved: 02-28-2013

(Superseding NASA-HDBK-2203)

DOCUMENT HISTORY LOG

Status

Document Revision

Approval Date

Description

Baseline

1

02-28-2013

Initial Release





FOREWORD

This Handbook is published by the National Aeronautics and Space Administration (NASA) as a guidance document to provide engineering information; lessons learned; possible options to address technical issues; classification of similar items, materials, or processes; interpretative direction and techniques; and any other type of guidance information that may help the Government or its contractors in the design, construction, selection, management, support, or operation of systems, products, processes, or services.

This Handbook is approved for use by NASA Headquarters and NASA Centers, including Component Facilities and Technical and Service Support Centers.

This wiki based Handbook provides users and practitioners with guidance material for implementing the requirements of NPR 7150.2, NASA Software Engineering Requirements. Use of this Software Engineering Handbook (SWEHB) in intended to provide "best-in-class" guidance for the implementation of safe and reliable software in support of NASA projects. This SWEHB is a key component of the NASA Software Engineering Working Group's (SWG) implementation of an Agency-wide plan to work toward a continuous and sustained software engineering process and product improvement.

Requests for information, corrections, or additions to this Handbook should be submitted via "Feedback" in the NASA Standards and Technical Assistance Resource Tool at http://standards.nasa.gov/.


?#scanned signature below#

28 Feb 2013

Michael G. Ryschkewitsch
NASA Chief Engineer

Approval Date

Resources

Accessing Other Versions of SWEHB

The version of the handbook that you are viewing is noted in the header image.

Clicking on this image while in any page of the SWEHB will take you back to the Introduction page for this version.

To access other versions of the Software Engineering Handbook use the links below:


5.1 SWE History

The SWE History Summary includes all SWE numbers and their history of use in all versions of the Software Engineering Handbook.

Click SWE History to view.

  • No labels

1 Comment

  1. Thank you for your interest in the Software Engineering Handbook (SWEHB). We are in the process of adding a PDF to this (Intro) section of the handbook. I recommend checking back periodically. Please be aware that it is a very large file (nearly 10 MB) that contains over 900 pages to date and it is likely to grow well beyond that. It will also not reflect the continuing real-time changes that will occur per its design.

    If you would like a copy of the current PDF file, please leave your contact information and a member of the SWEHB team will contact you with it.

    Regards,

    Lee the Editor