Overview
This activity describes the process of placing a modified document (copied from the software configuration management (SCM) library) under SCM.
Roles and Responsibilities
See parent activity 2.1. Place Products Under Software Configuration Management.
Controls
See parent activity 2.1. Place Products Under Software Configuration Management.
Inputs
A Promotion Notification Form (PNF) (see Appendix C), partially completed by the developer and the software engineering manager (or project software manager).
A modified document (copied from the SCM library).
Procedures
Note: The directories described in the following steps may vary depending on the directory structure defined in the Configuration Identification section of the project’s SCM Plan (SCMP) (see Appendix E). The directories are shown as examples only.
Prior to starting this activity, the document author checks a product out of the SCM library for revision.
1) The software librarian reviews the PNF. The document author and software engineering manager (or project software manager) should have partially completed the form to indicate if the document was approved to be baselined. If the document is a modified, baselined document, the form must also reference an approved Software Change Request (SCR) (see Appendix C) justifying the changes made.
2) The software librarian assigns a unique filename to the document based on the naming and numbering scheme described in the Configuration Identification section of the SCMP.
3) The software librarian verifies that the Revision History of the document is correctly completed and the SCR is referenced (if the document is a modified, baselined document).
4) If the document is approved to be baselined, the software librarian moves the document to the baseline directory (see Example 1).
Example 1:
project_volume\SHARED\BASELINE\DOCUMENT\ document_type\document_filename
project_volume\CSCI_Name\CONFIG\BASELINE\DOCUMENT\ document_type\document_filename
If the document is not approved by management for baselining, but is simply approved for promotion, the software librarian moves the document into the integration directory (see Example 2).
Example 2:
project_volume\SHARED\INTEGRATION\DOCUMENT\ document_type\document_filename
project_volume\CSCI_Name\CONFIG\INTEGRATION\DOCUMENT\document_type\ document_filename
Upon moving the document to the appropriate location, the software librarian sets up the access restrictions specified in the Configuration Identification section of the SCMP.
5) The software librarian verifies that the document was moved to the correct directory and correctly named.
6) If the updated document being placed under SCM is a modified, baselined document, the software librarian notes in the project’s SCM tracking system that each SCR responsible for a changes was implemented and is now closed. If an implemented SCR was generated as a result of a Software Trouble Report (see Appendix C) and all other SCRs generated by that Software Trouble Report were closed, the librarian also marks the report as closed.
7) The software librarian signs the PNF, and sends a copy to the document author(s) and software engineering manager, indicating that it was placed under SCM. If the document was baselined, the software librarian also notifies the project software manager. The software librarian places the PNF in the SCM tracking system.
8) The software librarian updates the document’s status (i.e., baselined or in integration) in the SCM tracking system. The software librarian may accomplish this using a product list that tracks the status of each software product being developed during the project cycle.
Outputs
The revised document, which was placed in the correct directory using the correct filename.
The notification (via the PNF) of the software engineering manager and the author(s) that the revised document was placed under SCM.