bannera

Book A.
Introduction

Book B.
7150 Requirements Guidance

Book C.
Topics

Tools,
References, & Terms

SPAN
(NASA Only)

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 27 Next »

Error formatting macro: alias: java.lang.NullPointerException
SWE-103 - Software CM Plan
Unknown macro: {div3}

1. Requirements

5.1.2.1 The Software Configuration Management Plan shall contain:

a.  The project organization(s).
b.  Responsibilities of the software configuration management organization.
c.  References to the software configuration management policies and directives that apply to the project.
d.    All functions and tasks required to manage the configuration of the software, including configuration identification, configuration  control, status accounting, and configuration audits and reviews.
e.  Schedule information, which establishes the sequence and coordination for the identified activities and for all events affecting the plan's implementation.
 f.  Resource information, which identifies the software tools, techniques, and equipment necessary for the   implementation of the activities.
 g.  Plan maintenance information, which identifies the activities and responsibilities necessary to ensure continued planning during the life cycle of the project.
 h.  Release management and delivery.

1.1       Notes

NPR 7150.2 does not include any notes for this requirement.

1.2       Implementation Notes from Appendix D

NPR 7150.2 does not include any notes for this requirement.

1.3       Applicability Across Classes

This requirement applies to all classes and safety criticalities except:

  • Class E and not Safety Critical
  • Class H

    Class B, Class B Safety Critical and Classes C through E Safety Critical are labeled, "P(Center) + SO". This means that this requirement applies to the safety-critical aspects of the software and that an approved Center-defined process which meets a non-empty subset of the full requirement can be used to achieve this requirement.

    Class C not Safety Critical, Class D not Safety Critical, and Class G are labeled with "P(Center)".  This means that an approved Center-defined process which meets a non-empty subset of the full requirement can be used to achieve this requirement.

Class

  A_SC 

A_NSC

  B_SC 

B_NSC

  C_SC 

C_NSC

  D_SC 

D_NSC

  E_SC 

E_NSC

     F      

     G      

     H      

Applicable?

   

   

   

   

   

   

   

   

   

   

   

    P(C)

   

Key:    A_SC = Class A Software, Safety Critical | A_NSC = Class A Software, Not Safety Critical | ... | - Applicable | - Not Applicable
X - Applicable with details, read above for more | P(C) - P(Center), follow center requirements or procedures

Unknown macro: {div3}

2. Rationale

Configuration Management is the "process of identifying and defining the configuration items in a system, controlling the release and change of these items throughout the system life cycle, recording and reporting the status of configuration items and change requests, and verifying the completeness and correctness of configuration items." (NASA Software Safety Guidebook, NASA-BG-8719.13). 1 This work can only be properly accomplished if there exists a plan addressing all of these activities which has been reviewed by an appropriate set of stakeholders and tailored for a specific project's needs.

Unknown macro: {div3}

3. Guidance

The software configuration management (SCM) plan may be tailored by software classification.  Goddard Space Flight Center (GSFC)'s Requirements for Minimum Contents of Software Documents6 provides one suggestion for tailoring a SCM plan based on the required contents and the classification of the software being developed.

When creating a SCM plan, using a template ensures consistent plans for all projects at a center.  Consider the following guidance, listed by the required elements shown in the NPR 7150.2A text for this SWE above, to ensure that all the required content is properly addressed and tailored for the project:

Project organization(s)

Consider the following when writing the project organization section of the SCM:

  • Describe where SCM fits into the technical and managerial reporting chain of the project
  • Identify by role project personnel responsible for managing the SCM activities for the project
  • Identify by role those persons on the project who will carry out SCM activities for the project

Responsibilities

The responsibilities of the software configuration management organization should address:

  • Responsibilities for each role participating in SCM activities, including team personnel, Leads, Change Control Board (CCB), quality assurance, managers, and any other roles relevant for the project
  • Responsibilities for carrying out each of the SCM functions defined in the SCM plan
  • Responsibilities of each CCB established for the project, including references to their charters or other governing documents (purpose, objectives, scope of authority, duration of existence) and the hierarchy among the CCBs; charts or diagrams may be helpful here
  • CCB participants either by project name and role or individual names
  • CCB meeting schedules, if not captured elsewhere
  • Responsibilities for releasing software, if not captured elsewhere
  • Provider roles and integration of provider SCM into overall project SCM
  • Responsibilities for maintaining SCM tools

References to SCM policies and directives

This section of the SCM plan should list any specific SCM policies and directives that apply to or impact SCM for the project.  Those policies and directives may be named in a reference section of the plan, so referring to that section may be appropriate.  However, the impact of those policies and directives on SCM for the project should be described here.

Consider:

  • Existing CCB procedures
  • Existing status accounting procedures
  • Existing configuration identification procedures
  • Existing audit procedures

All functions and tasks required to manage the configuration of the software

This section of the plan should describe configuration identification, configuration control, status accounting, and configuration audits and reviews.  See related guidance for each of these topics in this handbook.

This section of the SCM plan should describe how each of these SCM functions will be performed.  Consider using a separate subsection for each of the 4 functions.  As appropriate for the project, the following highlights should be included, but should not be considered the only items to document:

  • List of configuration items (or reference to where it can be found or how it can be obtained)
  • Naming convention for configuration items
  • Activities to define, track, store, and retrieve configuration items
  • Process for capturing a configuration item in the SCM system
  • How to request a change (how to enter a CR and get it into the review & approval process)
  • Levels of control for changes (CCBs)
  • Activities for verifying and implementing an approved change
  • Schedule, purpose, responsible party for status accounting forms and reports, including metrics
  • Access to status accounting data
  • List, description, and purpose of planned SCM audits and reviews

If the project uses data management in addition to SCM, those activities should be described in this section of the SCM plan, including:

  • Receiving data
  • Cataloging data
  • Maintaining status records
  • Establishing and maintaining secure data access and control
  • Providing change control monitoring and review
  • Archiving data

Schedule

This section of the plan should include information necessary to describe "the sequence and coordination for the identified activities and for all events affecting the plan's implementation." (NPR 7150.2)  The SCM schedule should coordinate with the project schedule and this part of the SCM plan should show that coordination.  Graphics (timelines) may be useful.

Typically, configuration items are uncontrolled until some "gate" or milestone is reached when they are required to be placed under configuration control.  Each configuration item or group of items may have its own "gate".  Because those "gates" can be points in the project timeline, consider describing those "gates" in this section.

Also consider for the SCM schedule:

  • Timeline or phase for creation of planned baselines
  • SCM audit schedule

Resources

"Software Configuration Management is usually performed using a tool (program). However, a file or folder should be maintained, to collect information that is not in electronic form. This information could include the design notes scribbled on a napkin or a fax that only exists in hardcopy. The point is to collect all pertinent information in one place. It is a good idea to catalog all the hardcopy information in the electronic SCM system, so that it can be found again when needed." (NASA Software Safety Guidebook)

The resources section of the SCM plan should describe the software tools, techniques, and equipment that will be used to carry out SCM for the project.  References to the relevant documentation for installing and using these tools should be included as well as the configuration controls for each tool.

"Software Configuration Management is usually performed using a tool (program). However, a file or folder should be maintained, to collect information that is not in electronic form. This information could include the design notes scribbled on a napkin or a fax that only exists in hardcopy. The point is to collect all pertinent information in one place. It is a good idea to catalog all the hardcopy information in the electronic SCM system, so that it can be found again when needed." (NASA Software Safety Guidebook)

Typical resources include:

  • Personnel (note level of effort and any required training and/or qualifications)
  • Tools for managing source code, documents, requirements, design and any other configuration items
  • Tools for managing change requests if not integrated with the main configuration management tool
  • Tools for managing data not subject to configuration control and CCB change authority such as meeting minutes, reports, action items, corrective actions
  • Manual procedures
  • Equipment to support or host SCM tools
  • Training for SCM personnel

"Describe how the project will manage information throughout its life cycle, including the development and maintenance of an electronic program library. Explain how the project will ensure identification, control, and disposition of project records in accordance with NPD 1440.6, NASA Records Management, and NPR 1441.1, Records Retention Schedules." (NASA Space Flight Program and Project Management Requirements, NPR 7120.5D)

Plan maintenance

The maintenance section should provide information such as:

  • History of changes
  • Role responsible for monitoring the SCM plan
  • Frequency of scheduled updates
  • Process for evaluating and approving changes to the SCM plan
  • Process for implementing and communicating approved changes to the SCM plan

Release management and delivery

Per the NASA Software Safety Guidebook, "Configuration Management should act as the sole distributor of media and documentation for all system tests and for delivery to [sub]system integration and testing. Pulling the latest program off the developer's machine is not a good idea. One aspect of system testing is repeatability, which can only be assured if the software under test comes from a known, and fixed, source."1

The release management and delivery activity should be described in this portion of the SCM plan (see SWE-085 [[k1]|#_msocom_1] for release management guidance), including formal control of the build, release, and delivery of software products and documentation.

Consult center Process Asset Libraries (PALs) for center-specific guidance, templates, and resources related to the content of the configuration management plan.

Additional guidance related to the content of the configuration management plan may be found in the following related requirements in this handbook:

SWE-079

Develop CM Plan

SWE-081

Identify Software Configuration Management Items

SWE-082

Authorizing Changes

SWE-083

Status Accounting

SWE-084

Configuration Audits

SWE-085

Release Management

 

 

Unknown macro: {div3}

4 Small Projects

Configuration management activities are based on risk, so projects designated small by size of the team or budget should ensure that their SCM plans include all the required content while including only those processes and the associated structure necessary to manage project risk.  This might mean planning to use simpler tools or fewer personnel (filling multiple roles) to carry out the SCM processes.  It could also mean planning to use a single tool for multiple purposes to reduce tool management and overhead.

Small projects may not require the formality of a separate SCM plan; instead SCM planning may be documented as a section of the project's Software Management Plan. Alternatively, one master SCM plan may document CM for multiple small projects.

Unknown macro: {div3}

5. Resources

  1. NASA Technical Standard, "NASA Software Safety Guidebook", NASA-GB-8719.13, 2004.
  2. NASA Procedural Requirements, "NASA Space Flight Program and Project Management Requirements", NPR 7120.5D, 2007.
  3. IEEE Computer Society, "IEEE Standard for Software Configuration Management Plans", IEEE STD 828-2005, 2005. [[k1]|#_msocom_1]  This link requires an account on the NASA START (AGCY NTSS) system (http://standards.nasa.gov ).  Once logged in, users can access Standards Organizations, IEEE and then search to get to authorized copies of IEEE standards[[k2]|#_msocom_2] .
  4. IEEE Computer Society, "IEEE Guide to Software Configuration Management", IEEE STD 1042-1987, 1987.  This link requires an account on the NASA START (AGCY NTSS) system (http://standards.nasa.gov ).  Once logged in, users can access Standards Organizations, IEEE and then search to get to authorized copies of IEEE standards.
  5. NASA Technical Standard, "NASA Configuration Management (CM) Standard", NASA-STD-0005, 2008.
  6. GSFC Software Engineering Division, "Requirements for Minimum Contents of Software Documents[[k3]|#_msocom_3] ", 580-STD-077-01, 2010.
  7. NASA IV&V, "Sample Configuration Management Plan", T2401, Revision A, 2009.  Note: This plan includes the following note, "This sample CMP was created by the Carnegie Mellon Software Engineering Institute. The original URL of this plan is http://www.sei.cmu.edu/legacy/scm/papers/CM_Plans/CMPlans.AppendixB.html. "
  8. Madden, Michael, Unisys Corporation (for Langley Research Center), "Simulation Project Software Configuration Management (SCM) Plan[[k4]|#_msocom_4] ", 1996.  This is listed as a Best Practice on the LaRC PAL site (http://sw-eng.larc.nasa.gov/resource.cfm ).  It is an example, not a practice/process.  Note that it is from 1996 and it is based on IEEE Std 828-1990 which has been superseded by 828-2005.
  9. Langley Research Center, "Software Configuration Management Plan[[k5]|#_msocom_5]  - Example 2a", 2000.
  10. Software Configuration Management[[k6]|#_msocom_6] , GRC-SW-7150-9, Revision B, Glenn Research Center (GRC), 2011.

5.1 Tools

add

Unknown macro: {div3}

6. Lessons Learned

The NASA Lessons Learned database includes the following lesson learned related to software configuration management:

Project Attention to Configuration Control: (http://www.nasa.gov/offices/oce/llis/imported_content/lesson_2476.html): "Project attention to the configuration control of flight scripts is likely to prevent the generation of unnecessary software iterations, improve the rigor of mission system engineering processes, and ensure consistency in the test and operations environments."


  • No labels