System Integration Project Management Engineer (Soft Examination Intermediate Level)——Chapter 20 Documentation and Configuration Management Note Sharing

• foreword

  Now share some notes with everyone, hoping to help you pass the soft test smoothly .

• Curtain Address: Chapter 20 Documentation and Configuration Management - Curtain

• overview

  • Big Data

    

• 1 version management

  • Classification

    • 1. Development documents

      • Describe the development process itself
      • Feasibility study reports and project briefs; requirements specifications; functional specifications; design specifications, including program and data specifications; development plans; software integration and test plans; quality assurance plans; safety and testing information

    • 2. Product Documentation

      • Describe the products of the development process
      • Training manuals; reference manuals and user guides; software support manuals; product manuals and informational advertisements

    • 3. Manage documents

      • Record information for project management
      • Records of progress and progress changes at each stage of the development process; records of software changes; definition of responsibilities for the development team

  • grading

    • Level 1 Minimum Documentation

      • Suitable for self-use programs for developers whose development workload is less than one person-month

    • Level 2 Internal Documentation

      • Can be used for dedicated programs that do not share resources with other users

    • Level 3 Working Documentation

      • Suitable for programs jointly developed by several people in the same organization, or programs that can be used by other organizations

    • Level 4 Formal Documentation

      • Suitable for those software products that are officially released for general use

  • rule method

    • 1. Document writing specification

      • A unified writing standard should be followed, including the use of symbols, the meaning of icons, the use of comment lines in the program, indicating the person who wrote the document and the writing date, etc.

    • 2. Chart numbering rules

      • These charts are numbered regularly to facilitate the search of the charts

        

    • 3. Document catalog writing standards

    • 4. Document management system

      • A corresponding document management system should be established

• 2 configuration management

  • cycle

    • Covers the entire life cycle of the project

  • Activity

    • Develop configuration management plans, configuration identification, configuration control, configuration status reporting, configuration auditing, release management, and delivery

  • content

    • Project plans, requirements documents, design documents, source code, executable code, test cases, various data required to run the software

  • important point

    • Test reports, meeting minutes, and work records are not included in the content of configuration items; because once formed, it is difficult to modify

  • Operating authority

    • manage
      • Strictly managed by a Configuration Manager (CMO)
    • in principle
      • Baseline Configuration Items
        • Open read access to software developers
        • Includes all design documents and source code
      • Non-baseline configuration items
        • Open to PM, Change Control Board CCB and related personnel
        • Including various plans and reports of the project, etc.

  • configuration item status

    

    • tips
      • When a configuration item is first created, its status is "Draft"
      • After the configuration item passes the review, its status becomes "official".
      • Afterwards, if the configuration item is changed, its status will become "Modified"
      • When the configuration item is modified and re-passed the review, its status becomes "official" again

    • draft

      • 0.YZ
      • The numerical range of YZ is 01~99. As the draft is revised, the value of YZ should be incremented.
      • The initial value and increase of YZ are determined by the user

    • formal

      • X.Y
      • X is the main version number, and its value ranges from 1 to 9. Y is the minor version number, the value range is 0~9

    • Revise

      • X.YZ
      • When the configuration item is being modified, generally only the Z value is increased, and the XY value remains unchanged
      • After the configuration item is modified and the status becomes "official", set the Z value to 0 and increase the XY value

  • version control

    • It acts on multiple configuration management activities, such as creating configuration items, changing configuration items, and reviewing configuration items, etc.
    • During the project development process, most of the configuration items have to go through multiple revisions before they can be finalized.
    • Any modification to configuration items will generate a new version
    • Since we cannot guarantee that the new version is necessarily "better" than the old version, the old version cannot be discarded
    • The purpose is to save all versions of configuration items according to certain rules, avoid version loss or confusion, and quickly and accurately find any version of configuration items

  • baseline

    • definition

      • Consists of a set of configuration items that form a relatively stable logical entity. The configuration items in the baseline are "frozen" and can no longer be modified by anyone
      • Changes to the baseline must follow a formal change control procedure
      • Work product owners can quickly and informally make changes to the product before establishing a baseline. After a baseline is established, changes are controlled through a formal process for evaluating and validating changes.

    • composition

      • Consists of a set of configuration items that form a relatively stable logical entity
      • The configuration items in the baseline are frozen and cannot be modified by anyone.
      • Baselines correspond to milestones in the development process, a product can have multiple baselines, or only one baseline
      • The baseline that gives total value to customers is called a release baseline "Release",
      • The baseline used for internal development is called a construction baseline "Build".
      • Configuration items can be changed. During the project development process, most of the configuration items have to undergo multiple modifications before they can be finalized. It is only necessary to do a good job in version control management

    • example

      • A set of uniquely identified requirements, design, source code files, and corresponding executable code, construction files, and user documentation form a baseline
      • A test version of a product (which may include a requirements analysis specification, a general design specification, a detailed design specification, compiled executable code, test outlines, test cases, user manuals, etc.) is an example of a baseline

    • content

      • Baselined events, controlled configuration items, procedures for establishing and changing baselines, authorizations required to approve changes to baselines

  • Classification

    • 1. Development library

      • Also known as a dynamic library, a programmer's library or a working library, it is used to save the matching entity that the developer is currently developing, and the configuration items in the dynamic are placed under version management
      • A developer's personal workspace, under the developer's own control. The information in the library may be modified more frequently

    • 2. Controlled library

      • Also known as the master repository, contains the current baseline plus changes to the baseline
      • Configuration items in a controlled repository are placed under full configuration management
      • At the conclusion of a phase of information system development, the current work product is deposited into a controlled repository

    • 3. Product library

      • Also known as a static library, release library, software repository, contains an archive of various baselines released for use, placed under full configuration management
      • After the developed information system product completes the system test, it is stored in the product library as the final product, waiting to be delivered to the user or installed on site

  • Database building mode

    • Type of configuration item

      • Development organizations for general software
      • The inheritance of products is often strong, the tools are relatively unified, and there is a certain demand for parallel development
      • It is conducive to the unified management and control of configuration items, and can also improve the efficiency of compilation and release
      • It is not for the development tasks of each development team, so it may cause the developer's working directory structure to be too complicated and cause some unnecessary troubles

    • development task

      • Development organizations for professional software
      • There are many types of development tools used, and the development model is mainly based on linear development, so there is no need to strictly classify and store configuration items, artificially increasing the complexity of the directory
      • For R&D software organizations, it is more flexible to adopt this setting strategy

    • tool

      • software
        • VSS CVS
      • manual

  • permissions

    • Operating authority

      

    • Controlled library

      

    • product library

      

  • Configure ID recognition

    • 1. Identify configuration items that need to be controlled
    • 2. Specify a unique identification number for each configuration item
    • 3. Define the important characteristics of each configuration item
    • 4. Identify the owner of each configuration item and their responsibilities
    • 5. Determine the time and conditions for configuration items to enter configuration management
    • 6. Establish and control a baseline
    • 7. Maintain the relationship between revisions of documents and components and product versions

  • Configure Administrator Responsibilities

    • 1. Write a configuration management plan
    • 2. Establish and maintain configuration management system
    • 3. Establish and maintain configuration library
    • 4. Configuration item identification
    • 5. Establish and manage baselines
    • 6. Version management and configuration control
    • 7. Configuration Status Report
    • 8. Configuration Audit
    • 9. Release Management and Delivery
    • 10. Conduct configuration management training for project members

  • Configuration Management Plan

    • 1. Configuration management activities, the main activities covered include configuration identification, configuration control, configuration status report, configuration audit, release management and delivery
    • 2. Specifications and procedures for implementing these activities
    • 3. Schedule for implementing these activities
    • 4. The persons or organizations responsible for carrying out these activities and their relationship to other organizations

  • Configuration Status Report

    • definition

      • Also known as configuration status statistics, its task is to effectively record and report the information required for configuration management. The purpose is to provide the current status of configuration items in a timely and accurate manner for relevant personnel to understand, so as to strengthen configuration management. Should focus on reflecting the status of the current baseline configuration items to report the progress of system development activities to managers

    • content

      • 1. The identification and status of each controlled configuration item. Once a configuration item has been placed under configuration control, the version and status of each of its subsequent developments should be recorded and saved
      • 2. Status of each change request and implementation status of approved modifications
      • 3. The status of current and past versions of each baseline and a comparison of versions
      • 4. Records of other configuration management process activities

  • configuration control

    • 1. Change application

      • Relevant personnel such as project managers fill in the change application form

    • 2. Change the evaluation warehouse

      • The CCB decides whether to accept the change and notifies the relevant personnel of the decision.

    • 3. Notification of evaluation results

    • 4. Change implementation

      • The project manager organizes the modification of related configuration items, and records the change information in the corresponding documents or program codes.

    • 5. Change verification and confirmation

      • The project manager designates personnel to test or verify the changed configuration items.

    • 6. Publication of Changes

      • The configuration administrator notifies relevant personnel of the changes and results, and makes records.

    • 7. Change control based on configuration library

      

      • ①Take out the baseline to be upgraded from the product library and put it into the controlled library;
      • ②The programmer checks out the code segment to be modified from the controlled library (Check out), and puts it into his own development library for modification. After the code is checked out, it is "locked" to ensure that the same piece of code can only be modified by one programmer at the same time. If A is modifying it, B cannot check out;
      • ③ The programmer checks the modified code segment in the development library into (Check in) the controlled library. After Check in, the "lock" of the code is released, and other programmers can check out the code segment;
      • ④ After the upgrade and modification of software products are all completed, store the new baseline in the controlled library into the product library

  • configuration audit

    • Purpose

      • 1. Prevent the submission of unsuitable products to users, such as delivery of incorrect versions of user manuals
      • 2. Incomplete implementations are found, such as development that does not meet the initial specification or changes that are not implemented in accordance with the change request
      • 3. Find out the mismatch or incompatibility between configuration items
      • 4. Confirm that the configuration item has been included in the baseline and stored in the library after the required quality control review
      • 5. Verify that records and documentation are maintained for traceability

    • Classification

      • Function configuration audit consistency
        • 1. The development of configuration items has been successfully completed
        • 2. The configuration item has achieved the specified performance and function-specific characteristics
        • 3. The operation and supporting documents of the configuration items have been completed and meet the requirements
      • Physical Configuration Audit Integrity
        • 1. The configuration items of each build conform to the corresponding technical documents
        • 2. The configuration items correspond to the information in the configuration status report

  • Release Management and Delivery

    • Contains: storing, copying, packaging, delivering, rebuilding