Overview
This activity describes the process of placing a new document under software configuration management (SCM).
Roles and Responsibilities
See parent activity 2.1. Place Software Products Under Software Configuration Management.
Controls
See parent activity 2.1. Place Software 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 new document that was not placed under SCM.
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.
1) The software librarian reviews the PNF. The document author and the software engineering manager (or project software manager) should have partially completed the form to indicate if the document was approved to be baselined or placed in an integration directory. If the document is to be baselined, the project software manager’s signature (or some electronic approval) is required. If the document is to be placed in the integration directory, only the software engineering manager’s signature is required.
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) If the document was 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_file-name
Upon moving the code to the appropriate location, the software librarian sets up the access restrictions specified in the Configuration Identification section of the SCMP.
4) The software librarian signs and numbers the PNF, and sends a copy of it to the software engineering manager and the author(s), indicating that the document was promoted. If the document was baselined, the software librarian also notifies the project software manager. The librarian places the PNF in the SCM tracking system.
5) The software librarian enters the document’s status (i.e., baselined or integration) into the SCM tracking system. The librarian can accomplish this by using a product list that tracks the status of each software product being developed during this cycle.
Outputs
The document that was placed in the correct directory and labeled with the correct filename, as stated in the SCMP.
The completed PNF, sent by the software librarian to the software engineering manager, author(s), and (if the document was baselined) project software manager.