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 34 Next »

Error rendering macro 'alias'

null

SWE-074 - Document Maintenance Plan

1. Requirements

3.5.1 The project shall document the software maintenance plans in a Software Maintenance Plan document.

1.1 Notes

The requirement for the content of a Software Maintenance Plan is defined in Chapter 5 [of NPR 7150.2, NASA Software Engineering Requirements, Section 5.1.4].

1.2 Applicability Across Classes

Class G is 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

2. Rationale

Per NPR 7150.2, "Planning for operations, maintenance, and retirement must be considered throughout the software life cycle. Operational concepts and scenarios are derived from customer requirements and validated in the operational or simulated environment. Software maintenance activities sustain the software product after the product is delivered to the customer until retirement...The Software Maintenance Plan provides insight into the method, approach, responsibility, and processes to be followed for maintenance of software and its associated documentation."

3. Guidance

The software maintenance plan describes operations, maintenance, and retirement activities (see the guidance in this Handbook for SWE-075). The maintenance plan is typically a separate plan, but may be part of another project document such as the Software Management Plan (SMP). For existing processes that may be used during operations, maintenance, and retirement, the maintenance plan may simply reference existing project documents that describe those processes.

One key goal of the software maintenance plan is to document the plans for maintaining a piece of software, especially in the case that an organization assumes responsibility for maintaining a piece of software developed by another organization. The maintenance plan is not intended, however, to require updates to other planning documents from the software development life cycle, such as the software development plan. The maintenance plan becomes the planning document for the maintenance phase of the software life cycle.

The maintenance plan generally has minimal content at the beginning of a project and becomes more complete and mature as the software life-cycle proceeds. This handbook provides the recommended maturity of the maintenance plan at major milestone reviews (see 7.8 - Maturity of Life Cycle Products at Milestone Reviews).

See SWE-105 in this Handbook for guidance on required maintenance plan contents, but consider the following topics as well when developing the maintenance plan, as appropriate for the particular project:

Operations

  • Mission support procedures for troubleshooting software problems. 001
  • Test of ground displays and software during mission sequence tests or other end-to-end tests. 001
  • Software support as required by the operations support facility. 001
  • Software safety (if not addressed in the software safety plan). 271
  • Performance assessments, as applicable. 273
  • Training for replacement operators and maintainers. 273

Maintenance

  • Corrective maintenance for software defects. 001
  • Adaptive maintenance for "software changes necessitated by other changes, usually to the hardware." 001
  • Changing requirements maintenance. 001
  • Operational data maintenance to support system configuration changes needed to use the software. 001
  • Maintenance after new revisions of the software are released.
  • Software safety (if not addressed in the software safety plan). 271
  • Updates to operations and user manuals, traceability matrices. 276
  • User notification of updates. 209

Retirement

  • Archival of project software products. 001
  • Archival of project metrics data. 001
  • Software safety (if not addressed in the software safety plan). 271
  • User notification of retirement. 209
  • Decommissioning and disposal. 273
  • Capture of Lessons Learned. 273

Other

  • Disposition of

    <ac:macro ac:name="unmigrated-wiki-markup">
    <ac:plain-text-body><![CDATA[

    COTS

    ]]></ac:plain-text-body>
    </ac:macro>

    components (source code, licenses, etc.). 072
  • Support, if required from a contracted developer (established via contract or other agreement).
  • Support tools required for operations, maintenance, retirement activities, including how to address obsolescence of any such tools over the operational life of the project.
  • Allocation of responsibilities for operations support, maintenance, retirement activities. 273

Once the maintenance plan is created, it is peer reviewed and reviewed at project milestone reviews such as the Mission Concept Review (MCR), Software Requirements Review (SwRR), Mission Definition Review (MDR), etc. (see Topic 7.8 - Maturity of Life Cycle Products at Milestone Reviews in this Handbook).  

Consult Center Process Asset Libraries (PALs) for Center-specific guidance related to documenting the maintenance plan.

Additionally, guidance related to maintenance plans may be found in the following related requirements in this handbook:

SWE-075

Plan Operations, Maintenance, Retirement

SWE-076

Implement Operations, Maintenance and Retirement Activities

SWE-105

Software Maintenance Plan


4. Small Projects

For projects with limited staff or budgets, consider adapting a maintenance plan from a similar project making sure to update the plan to reflect the current project's operations, maintenance, and retirement plans. The contents of a maintenance plan can also be addressed as sections in another project document and is not required to be in a separate document.

5. Resources

  • (SWEREF-001) Software Development Process Description Document, EI32-OI-001, Revision R, Flight and Ground Software Division, Marshall Space Flight Center (MSFC), 2010. This NASA-specific information and resource is available in Software Processes Across NASA (SPAN), accessible to NASA-users from the SPAN tab in this Handbook.

  • (SWEREF-072) Checklist for the Contents of Software Critical Design Review (CDR), 580-CK-008-02, Software Engineering Division, NASA Goddard Space Flight Center (GSFC), 2010. This NASA-specific information and resource is available in Software Processes Across NASA (SPAN), accessible to NASA-users from the SPAN tab in this Handbook.

  • (SWEREF-138) Software Maintenance Boeing, Houston Procedure, HOU-EGP-333, 2002. This NASA-specific information and resource is available in Software Processes Across NASA (SPAN), accessible to NASA-users from the SPAN tab in this Handbook.

  • (SWEREF-209)

    IEEE Computer Society, IEEE Std 1012-2012 (Revision of IEEE Std 1012-2004), This link requires an account on the NASA START (AGCY NTSS) system (https://standards.nasa.gov ). Once logged in, users can access Standards Organizations, IEEE and then search to get to authorized copies of IEEE standards.

  • (SWEREF-271)

    NASA STD 8719.13 (Rev C ) , Document Date: 2013-05-07

  • (SWEREF-273)

    NASA SP-2007-6105, Rev2, NASA Headquarters, Jan, 2020.

  • (SWEREF-276)

    NASA-GB-8719.13, NASA, 2004.

  • (SWEREF-278)

    NASA-STD-8739.8A , NASA TECHNICAL STANDARDS SYSTEM, Approved 2020-06-01 Superseding "NASA-STD-8739.8, With Change 1"

  • (SWEREF-540)

    Public Lessons Learned Entry: 1128.

  • (SWEREF-543)

    Public Lessons Learned Entry: 1153.

5.1 Tools

Tools to aid in compliance with this SWE, if any, may be found in the Tools Library in the NASA Engineering Network (NEN).

NASA users find this in the Tools Library in the Software Processes Across NASA (SPAN) site of the Software Engineering Community in NEN.

The list is informational only and does not represent an “approved tool list”, nor does it represent an endorsement of any particular tool. The purpose is to provide examples of tools being used across the Agency and to help projects and centers decide what tools to consider.


6. Lessons Learned

The NASA Lesson Learned database contains the following lessons learned related to maintenance planning:

  • Computer Hardware-Software/Software Development Tools/Maintenance. Lesson Number 1128: "NASA concurs with the finding that no program-wide plan exists addressing the maintenance of

    <ac:macro ac:name="unmigrated-wiki-markup">
    <ac:plain-text-body><![CDATA[

    COTS

    ]]></ac:plain-text-body>
    </ac:macro>

    software development tools. A programmatic action has been assigned to develop the usage requirements for COTS/modified off-the-shelf software including the associated development tools. These guidelines will document maintenance and selection guidelines to be used by all of the applicable program elements." 540  
  • International Space Station (ISS) Program/Computer Hardware-Software/International Partner Source Code (Maintenance Agreements.) Lesson Number 1153:  The Recommendation states to "Solidify long-term source code maintenance and incident investigation agreements for all software being developed by the International Partners as quickly as possible, and develop contingency plans for all operations that cannot be adequately placed under NASA's control." 543
  • No labels