github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/docs/design_docs/DesignDocTemplate.md (about)

     1  
     2  # Changelog
     3  |  Version  | Date  | Changelog  |
     4  |  ----  | ----  | ----|
     5  | 1.0.0  | 2022.x.x | initial version |
     6  | x.x.x  | x.x.x |* *|
     7  
     8  # Review history
     9  |  Reviewer | Required/Optional Reviewer | Approved?| Date
    10  |  ----  | ----  | ----| ----|
    11  | x.x.x  | Required | Approved | |
    12  | x.x.x  | Required | Approved | | 
    13   
    14  
    15  # Naming rule：Product vMajor-XX Investigation/Requirement/Design
    16  eg：kubeblocksv0-XXdesign, vMajor follows the product's version number
    17  
    18  # Release checklist
    19  eg：
    20  > - The document has been approved by required approvers
    21  > - Design details are appropriately documented
    22  > - Test plan is in place
    23  > - User-facing documentation have been uploaded to github
    24  > - Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
    25   
    26  # Summary
    27  
    28  # Terms and Concepts
    29  
    30  # Motivation
    31  
    32  ## Goals
    33    - Requirement1:
    34    - Requirement2:
    35    - Requirement3:
    36  ## Non-Goals
    37    - Requirement1:
    38    - Requirement2:
    39    - Requirement3:
    40    
    41  # Notes/Constraints/Caveats (Optional)
    42    
    43  ## Background
    44    
    45  ## Alternatives solution
    46    
    47  ## User stories
    48  - Story1
    49  - Story2
    50    
    51  
    52  # Architecture design（Components、Architecture diagram）
    53  
    54  ## Architecture diagram
    55  
    56  ## External interface design
    57  
    58  ## Internal component design
    59  
    60  ## Development plan
    61  
    62  ## Compatibility（Software/Hardware）
    63  
    64  ## Technical indicator
    65  *（eg Scalability、capacity、performance）*
    66  
    67  ## Implementation History（Optional）
    68  
    69  ## Test Plan
    70  - Prerequisite testing updates
    71  - Unit tests
    72  - Integration tests
    73  - e2e tests
    74  - fault injection tests
    75  
    76  
    77  # Others
    78  ## Risks and Mitigations（Optional）
    79  ## Database security（Optional）
    80  ## Infrastructure Needed (Optional)
    81  ## References(Optional)
    82