A method for automatically generating MBSE system models and design documents

Abstract

The present disclosure provides an automatic generation method for supporting MBSE system model and design document. The MBSE system model project information is read, and the design document basic information is automatically generated. The design document structure is generated. The system design process information of the methodology model constructed in the MBSE system model project is read. The corresponding document chapter is generated according to the process design content C. The order of the document chapter is determined according to the design process sequence A. The outline level of each chapter in the design document is determined according to the hierarchical relationship in the design process hierarchy B. Based on the generated design document structure and the read design process corresponding model D, the model content is automatically filled for each chapter. The dynamic update of the design document content is carried out. Using the present application, the problems such as poor flexibility of the design document generation method based on templates and rules in the prior art, difficulty in dynamic synchronization of the document and the model, etc. can be solved, and the consistency of the system model and the design document is ensured.

Description

TECHNICAL FIELD

[0001] The application belongs to the technical field of complex system design and model-based system engineering, and particularly relates to a method for automatically generating MBSE system models and design documents. BACKGROUND

[0002] In the design process of complex systems, the model-based system engineering (MBSE) method has become an important method of modern system engineering. MBSE describes and manages the requirements, functions, behaviors and structures of a system by constructing system models. These system models not only help engineers to make more accurate analysis and optimization in the design stage, but also support the verification and validation (V&V) work in the entire system development life cycle. However, although the MBSE system model provides strong support for the construction, analysis and optimization of the system, the model itself cannot be used as the final deliverable of the project, especially in complex engineering projects involving multiple parties and compliance requirements.

[0003] In industrial applications such as aerospace, automotive, defense, etc., design documents that meet industry standards and regulatory requirements are key achievements in the system development process. These design documents are not only used for project acceptance, compliance review and delivery, but also provide important references for subsequent system maintenance, upgrade and product life cycle management. In highly regulated industries such as aerospace, the documented design process and verification process are necessary conditions for passing compliance reviews.

[0004] However, the process of converting MBSE system models into design documents faces many challenges. First, the data in the model is usually very complex, containing a large amount of multi-dimensional information that needs to be presented in a clear and structured manner to meet the needs of different audiences. Second, the system model is dynamic, and as the system design is constantly updated, the documented content also needs to be kept consistent in real time. Traditional manual methods often cannot effectively cope with frequent model iterations and updates, and may lead to inconsistencies between the document and the actual model. In addition, different design documents may need to extract different types of information from the system model, which makes the document generation scheme based on templates or rules not flexible enough when facing complex and diverse requirements.

[0005] Therefore, in the development of complex systems, there is an urgent need for an efficient and automated method to convert the structured data in the MBSE system model into design documents that meet the standards. This method not only reduces the time and errors of manually generating documents, but also ensures the dynamic consistency of the document content with the system model, thereby improving the efficiency and reliability of the entire system design and development process.

[0006] There are some attempts and solutions in the prior art:

[0007] (1) Template-based design document generation method: The prior art proposes an automatic generation method based on predefined document templates. Based on the predefined document template, the structure and attributes of the system model are extracted and automatically filled in the document template. This method is suitable for the generation of standardized documents, but its flexibility is poor and it cannot be dynamically adjusted according to the specific needs of different projects. In addition, the preparation and maintenance of templates require a lot of manual intervention, resulting in a cumbersome and error-prone generation process. In particular, when the system model is updated, the document content cannot be synchronized in a timely manner.

[0008] (2) Rule-based model-to-document conversion method: Relevant information is extracted from the system model and converted into design documents through pre-defined rules or mapping relationships. This method can flexibly respond to different document structure requirements, but it relies too much on pre-defined rules, and the writing and maintenance of rules are complex. Especially when the system model changes frequently, it is difficult to ensure the accuracy and consistency of the design document content. Dynamic document updates are difficult to automate, resulting in frequent inconsistencies between models and documents.

[0009] Therefore, it is necessary to design an automatic generation method for MBSE system models to design documents to solve the problems of poor flexibility and difficulty in dynamic synchronization of documents and models in existing technologies, realize the automatic generation and update of design documents, reduce manual intervention, improve the efficiency and accuracy of document generation, and ensure the consistency of documents and system models. Summary of the Invention

[0010] In view of this, the present invention provides a method for automatically generating MBSE system models and design documents, aiming to solve the problems of poor flexibility of template- and rule-based design document generation methods in the existing technology, and difficulty in dynamic synchronization of documents and models, so as to ensure the consistency of system models and design documents.

[0011] In order to solve the above technical problems, the present invention is implemented as follows.

[0012] A method for automatically generating MBSE system models and design documents, comprising:

[0013] Step 1: Read the MBSE system model project information and generate basic information of the design document;

[0014] Step 2: Generating design document structure: reading system design process information from the methodology model constructed in the MBSE system model project, including design process sequence A, design process level B, design process content C, and design process corresponding model D; generating corresponding document chapters according to the process design content C, determining the order of the document chapters according to the design process sequence A, and determining the outline level of each chapter in the design document according to the hierarchical relationship in the design process level B;

[0015] Step 3: Generating design document content: automatically filling model content for each chapter based on the generated design document structure and the read design process corresponding model D;

[0016] Step 4: Dynamic updating of design document content.

[0017] Preferably, the step 3 of automatically filling model content for each chapter specifically includes:

[0018] The design process corresponding model D includes a requirement entry model based on the requirement exchange format ReqIF, a system architecture model, and a traceability relationship model;

[0019] According to the requirement entry model, a requirement entry table and a requirement entry relationship table corresponding to the chapter in the design document are generated;

[0020] According to the traceability relationship model, a traceability table corresponding to the chapter in the design document is generated;

[0021] According to the system architecture model, pictures and picture descriptions are exported and inserted into the corresponding chapter of the design document structure generated in step 2.

[0022] Preferably, the step of generating a requirement entry table and a requirement entry relationship table corresponding to the chapter in the design document according to the requirement entry model is:

[0023] Mapping the requirement attributes including ID, name, and description in the requirement entry model to the columns of the requirement entry table;

[0024] Mapping each requirement entry in the requirement entry model to a row in the requirement entry table, and filling the attribute content into the corresponding attribute column of the row;

[0025] A requirement entry relationship table is separately generated in the design document for the association attributes between the requirement entries in the requirement entry model, including columns: relationship type, source requirement ID, target requirement ID, and used to represent the relationship between requirements.

[0026] Preferably, the step of generating a table corresponding to the chapter in the design document according to the traceability relationship model is:

[0027] For the design structure matrix DSM, the model elements in the DSM are mapped to the first row and the first column of the traceability table; the relationships between the model elements in the DSM are mapped to the middle part corresponding to the first row and the first column of the table, and the values at the corresponding positions in the table represent the relationships from the corresponding row to the column;

[0028] For the mapping table mTable recording the mapping relationship between elements in the form of a two-dimensional table, a table format is directly generated in the design document;

[0029] For the table Table with column as table item and content of action table item, a completely corresponding table is generated in the design document by row-to-row and column-to-column.

[0030] Preferably, the step 4 comprises automatically detecting model changes;

[0031] The automatic detection of model changes comprises detecting the changed parts and updating the content of the relevant chapters each time the MBSE system model is changed; wherein the detection content includes adding new components, adding new relationships, deleting components, deleting relationships, renaming elements, changing levels, layout changes in graphical models, changing attribute values, adding or removing attributes.

[0032] Preferably, the step 4 further comprises document integrity checking:

[0033] After each update of the design document, the integrity checking is automatically performed, including checking whether the chapter structure and the methodology model of the document are completely consistent, checking whether the pictures and picture descriptions in the design document are completely consistent with the system architecture model, checking whether the requirement item table and the requirement item relationship table in the design document are completely consistent with the requirement item model, and checking whether the traceability table in the design document is completely consistent with the traceability relationship model.

[0034] Preferably, the step 1 reads the MBSE system model project information and automatically generates the basic information of the design document, including:

[0035] Reading the project name to automatically generate the document title;

[0036] Reading the creation time of the MBSE system model as the creation time of the design document;

[0037] According to the latest modification record of the MBSE system model, the modification time of the design document is generated to ensure that the design document timely reflects the latest state of the MBSE system model.

[0038] Advantages:

[0039] (1) Fully automated document generation: Existing technologies mostly rely on templates or rules to generate documents, which are less flexible and less automated. This invention eliminates the need to pre-write complex rules or templates and can dynamically generate design documents based on the structure and content of the MBSE system model. This not only avoids the tedious process of manually defining the structure and improves flexibility, but also ensures the standardization and consistency of design documents in terms of basic information, document structure, and document content, thus achieving a fully automated document generation process.

[0040] (2) Dynamic synchronization of documents and models: Existing technologies have significant difficulties in synchronizing documents and models, especially when models change frequently. This invention uses a model change detection mechanism to synchronize document content in real time, ensuring that documents always reflect the latest system status.

[0041] (3) The present invention can not only automatically generate tables into design documents, but also utilize the characteristics of MBSE models built on graphical modeling languages ​​such as SysML to insert pictures and text descriptions into the corresponding chapters of the document, thereby intuitively displaying the system's functions, structure, and behavior models. BRIEF DESCRIPTION OF THE DRAWINGS

[0042] Figure 1 The flowchart of the method for automatically generating MBSE system models and design documents supported by the present invention.

[0043] Figure 2 An example of the MagicGrid methodology model.

[0044] Figure 3 This is an example of a requirements entry model based on the Requirements Interchange Format ReqIF.

[0045] Figure 4 Based on Figure 3 The Word requirement entry table generated by the requirement entry model.

[0046] Figure 5 Based on Figure 3 The Word requirement item relationship table generated by the requirement item model.

[0047] Figure 6 This is an example of a DSM table.

[0048] Figure 7 Based on Figure 6 The DMS table is a traceability relationship table generated in the design document.

[0049] Figure 8 This is an example of the mTable table.

[0050] Figure 9 Based on Figure 8mTable in the design document.

[0051] Figure 10 Table is an example of Table.

[0052] Figure 11 Table in the design document. Figure 10

[0053] System architecture model is an example of System Architecture. Figure 12

[0054] System architecture model in the design document. Figure 13 Figure 12 Specific embodiments

[0055] The present application will be described in detail below with reference to the accompanying drawings and embodiments.

[0056] The present application provides a method for automatically generating MBSE system model and design document, the basic idea of which is that, first, reading MBSE system model project information, automatically generating design document basic information. Then, based on the methodology model built in the model project, automatically generating design document structure. On this basis, reading system model information, automatically generating design document content. Finally, checking the integrity of the design document, performing dynamic update of the document content.

[0057] It can be seen that the present application can dynamically generate design documents according to the structure and content of the MBSE system model, realize the fully automated document generation process; also through the model change detection mechanism, real-time synchronization of document content, ensure that the document always reflects the latest system state.

[0058] Figure 1 The specific implementation steps of the method for automatically generating MBSE system model and design document supported by the present application are shown, as shown in Figure 1 specifically include the following steps:

[0059] Step 1: reading MBSE system model project information, automatically generating design document basic information.

[0060] In this step, according to the basic attributes of the project to which the MBSE system model belongs, the basic information of the document is automatically generated, including:

[0061] (1) Document name: reading the project name, automatically generating the document title.

[0062] (2) Creation time: reading the creation time of the system model, and taking it as the creation time of the design document.

[0063] ​​(3) Modification time: According to the latest modification record of the system model, the modification time of the document is generated,

[0064] Ensure that the document can timely reflect the latest state of the model.

[0065] Step 2: Generate design document structure

[0066] In this step, according to the specific system development methodology model (such as OOSEM, MagicGrid, and specific domain modeling methodology, etc.) in the MBSE model project, the standard-compliant design document structure is automatically generated. This process includes:

[0067] (1) Identify methodology model: Read the system design process information in the methodology model, including design process sequence A, design process level B, design process content C, and design process corresponding model D, etc.

[0068] Take the MagicGrid methodology as an example, the methodology model is shown in Figure 2 Read the design process sequence A in the MagicGrid methodology model, including:

[0069] Process in problem domain black box: Start → Stakeholder needs → Use case → System context → Effectiveness metrics;

[0070] Process in problem domain white box: Use case → Functional analysis → System requirements, Functional analysis → Logical subsystem → Effectiveness metrics;

[0071] Process in solution domain: Logical subsystem → Component structure → Component parameters → End, Component structure → Component behavior → Component requirements → End.

[0072] The design process level B of the MagicGrid methodology is two levels of problem domain and solution domain, and the problem domain is further divided into two sub-levels of problem domain black box and problem domain white box. The sub-levels are the design processes in the design process sequence A.

[0073] The design process content C of the MagicGrid methodology includes: Start, Stakeholder needs, Use case, System context, Effectiveness metrics, Functional analysis, System requirements, Logical subsystem, Component structure, Component parameters, Component behavior, Component requirements, End.

[0074] For the design process corresponding model D, each design process is associated with a corresponding model, for example Figure 2 In the problem domain black box of

[0075] (2) Generate a table of contents: Generate corresponding document chapters based on the process design content C, determine the order of the document chapters based on the design process sequence A, and determine the outline level of each chapter in the design document based on the hierarchical relationship in the design process hierarchy B.

[0076] for Figure 2 For example, this step automatically creates chapters such as "1 Problem Domain", "1.1 Problem Domain Black Box", 1.1.1 Stakeholder Needs, 1.1.2 Use Cases, 1.1.3 System Context, "1.2 Problem Domain White Box", 1.2.1 Functional Analysis, 1.2.2 System Requirements, 1.2.3 Logical Subsystems, "2 Solution Domain", 2.1 Component Structure, 2.2 Component Behavior, 2.3 Component Requirements, 2.4 Component Parameters, and Effectiveness Measurement, avoiding errors and inconsistencies in manual settings.

[0077] Step 3: Generate design document content

[0078] In this step, the document content is generated based on the design document structure and the design process corresponding model D in the read methodology model, and each chapter is automatically filled.

[0079] The design process model D includes a requirement entry model based on the requirements exchange format ReqIF, a system architecture model, and a traceability relationship model. The specific content format is generated as follows:

[0080] (1) Requirements table generation: The system generates requirements table based on the requirements entry model ( Figure 3 ), automatically generate the requirement item table for the corresponding chapter in the design document ( Figure 4 ) and requirement item relationship table ( Figure 5 ). The specific steps are:

[0081] First, map the requirement attributes (ID, name, and description) in the requirement item model to the columns of the requirement item table;

[0082] Then, each requirement item in the requirement item model is mapped to a row in the requirement item table, and its attribute content is filled into the corresponding attribute column of the row;

[0083] Finally, the association attributes between the requirement items in the requirement item model are used to generate a separate relationship table in the design document, namely the requirement item relationship table, which includes columns such as relationship type, source requirement ID, target requirement ID, etc., which are used to represent various relationships between requirements.

[0084] (2) Traceability table generation: Generate the traceability table for the corresponding chapter in the design document based on the traceability relationship model.

[0085] According to the design structure matrix (DSM), mTable (Mapping Table), Table, etc. The traceability relationship model is automatically generated in the design document, and the traceability relationship table is exactly the same.

[0086] As shown in Figure 6 , the DSM represents the relationship between elements in the form of a matrix, the first row and the first column of the matrix represent the elements in the model respectively, the diagonal part is not editable, and the value at the corresponding position in the matrix represents the relationship type; The core steps of generating the traceability table in the design document from the DSM are: 1) First, map the model elements in the DSM to the first row and the first column of the table; 2) Then, map the relationships between the model elements in the DSM to the middle part corresponding to the first row and the first column of the table, and the value at the corresponding position in the table represents the relationship from the corresponding row to the column. The generated traceability relationship is shown in, for example Figure 7 .

[0087] The mTable records the mapping relationship between elements in the form of a two-dimensional table, and directly generates a table format in the design document. See Figures 8-9 for an example.

[0088] The Table takes the column as the table item and the row as the table item content, and generates a completely corresponding table in the design document through row-to-row and column-to-column. See Figures 10-11 for an example.

[0089] In the above manner, the accuracy of the content and the correspondence with the model are ensured.

[0090] (3) Graphical content generation: The system architecture model generated using SysML and other graphical modeling languages has pictures and text descriptions, which are directly exported and automatically inserted into the corresponding position in the document based on the methodology model-generated outline, and the exported pictures are automatically inserted into the document with the text description of the model name. See Figures 12-13 for an example. Figure 13 The picture is above and the text is below.

[0091] Step 4: Dynamic update of document content

[0092] When the system model is modified, the system automatically updates the design document content. Through continuous synchronization with the MBSE system model, it is ensured that the latest version of the document always reflects the latest model information.

[0093] (1) Automatic detection of model changes: every time the model changes, the system detects the changed part and updates the content of the relevant chapter. Including updates: add new components, add new modules, subsystems, components, etc.; Add relationships, introduce new connections, interfaces or constraints, such as signal lines, physical connections, etc.; Delete components, remove modules or components that are no longer needed; Delete relationships, remove invalid or redundant interfaces, connections; Element renaming, modify the name of the module, parameter, relationship or interface; Level change, adjust the level of the module in the system, such as dissection; Position adjustment, layout changes in graphical models; Change the value of the module or system attribute; Add or remove properties of specific modules, etc.

[0094] (2) Document integrity check: After each design document update, the system automatically performs integrity checks, including checking whether the document chapter structure and methodology model are completely consistent, checking whether the pictures and picture descriptions in the design document and the system architecture model are completely consistent, checking whether the requirement item table in the design document and the requirement item relationship table and the requirement item model are completely consistent, and checking whether the traceability table in the design document and the DSM, mTable, Table traceability relationship model are completely consistent; If not, the system outputs the model name information that is not consistent on the console, ensuring the consistency of the document content and structure, and avoiding omissions.

[0095] The above specific embodiments only describe the design principles of the present application, and the shapes and names of the components in the description can be different and are not limited. Therefore, those skilled in the art of the present application can modify or equivalently replace the technical solutions described in the foregoing embodiments; and these modifications and replacements do not deviate from the purpose and technical solution of the present application, and should all belong to the protection scope of the present application.

Claims

1. A method for automatically generating MBSE system models and design documents, characterized in that: include: Step 1: Read the MBSE system model project information and generate basic information of the design document; Step 2: Generate the design document structure: Read the system design process information from the methodology model built in the MBSE system model project, including the design process sequence A, design process level B, design process content C, and design process corresponding model D; Generate corresponding document chapters according to the design process content C, determine the order of the document chapters according to the design process sequence A, and determine the outline level of each chapter in the design document according to the hierarchical relationship in the design process hierarchy B; Step 3: Generate design document content: Based on the generated design document structure and the read design process corresponding model D, automatically fill in the model content for each chapter; Step 4: Design dynamic updates of document content.

2. The method for automatically generating MBSE system models and design documents according to claim 1, wherein: The step 3 is to automatically fill in the model content of each chapter, specifically including: The design process corresponding model D includes a requirement item model, a system architecture model and a traceability relationship model based on the requirement exchange format ReqIF; Generate a requirement item table and a requirement item relationship table for the corresponding chapter in the design document according to the requirement item model; Generate a traceability table for the corresponding chapter in the design document based on the traceability relationship model; Based on the system architecture model, export pictures and picture descriptions and insert them into the corresponding chapters of the design document structure generated in step 2.

3. The method for automatically generating MBSE system models and design documents according to claim 2, wherein: The requirement item table and requirement item relationship table for the corresponding chapter in the design document are generated according to the requirement item model: Map the requirement attributes including ID, name and description in the requirement item model to the columns of the requirement item table; Map each requirement item in the requirement item model to a row in the requirement item table, and fill the attribute content into the corresponding attribute column of the row; The association attributes between the requirement items in the requirement item model are used to generate a requirement item relationship table in the design document, including columns: relationship type, source requirement ID, and target requirement ID, which are used to represent the relationship between requirements.

4. The method for automatically generating MBSE system models and design documents according to claim 2, wherein: According to the traceability relationship model, the table of corresponding chapters in the design document is generated as follows: For the design structure matrix DSM, the model elements in the DSM are mapped to the first row and first column of the traceability relationship table; the relationship between the model elements in the DSM is mapped to the middle part corresponding to the first row and the first column in the table, and the values ​​at the corresponding positions in the table represent the relationship between the corresponding rows and columns; For the mapping table mTable that records the mapping relationship between elements in the form of a two-dimensional table, a corresponding table format is directly generated in the design document; For a table with columns as table items and rows as table item contents, a completely corresponding table is generated in the design document in a row-by-row and column-by-column manner.

5. The method for automatically generating MBSE system models and design documents according to claim 1, wherein: Said step 4 includes automatically detecting model changes; The automatic detection of model changes is as follows: each time the MBSE system model is changed, the changed parts are detected and the contents of the relevant sections are updated; wherein the detection content includes the addition of new components, the addition of new relationships, the deletion of components, the deletion of relationships, the renaming of elements, the change of levels, the layout change in the graphical model, the change of attribute values, and the addition or removal of attributes.

6. The method for automatically generating MBSE system models and design documents according to claim 5, wherein: Said step 4 further includes a document integrity check: After each design document update, an integrity check is automatically performed, including checking whether the document chapter structure is completely consistent with the methodology model, checking whether the pictures and picture descriptions in the design document are completely consistent with the system architecture model, checking whether the requirement item table and requirement item relationship table in the design document are completely consistent with the requirement item model, and checking whether the traceability table in the design document is completely consistent with the traceability relationship model.

7. The method for automatically generating MBSE system models and design documents according to claim 1, wherein: Step 1 reads the MBSE system model project information and automatically generates the basic information of the design document, including: Read the project name and automatically generate the document title; Read the creation time of the MBSE system model as the creation time of the design document; Generate the modification time of the design document based on the latest modification record of the MBSE system model to ensure that the design document reflects the latest status of the MBSE system model in a timely manner.

Images