Automatic generation method supporting MBSE system model and design document

Abstract

The invention provides an automatic generation method supporting an MBSE system model and a design document. MBSE system model project information is read, and design document basic information is automatically generated; system design flow information of a methodological model constructed in an MBSE system model project is read, corresponding document chapters are generated according to flow design content C, the sequence of the document chapters is determined according to the design flow sequence A, and the outline level of each chapter in the design document is determined according to the hierarchical relation in the design flow hierarchy B; on the basis of the generated design document structure and the read design process corresponding model D, automatically filling each chapter with model content; and dynamically updating the content of the design document. The problems that in the prior art, a design document generation method based on templates and rules is poor in flexibility, and the document and the model are difficult to dynamically synchronize can be solved, and the consistency of the system model and the design document is guaranteed.

Description

Technical Field

[0001] The present invention belongs to the technical field of complex system design and model-based system engineering, and in particular relates to an automatic generation method supporting MBSE system models and design documents. Background Art

[0002] In the design process of complex systems, the model-based systems engineering (MBSE) approach has become an important method of modern systems engineering. MBSE builds system models to comprehensively describe and manage the system's requirements, functions, behaviors, and structures. These system models not only help engineers perform more accurate analysis and optimization during the design phase, but also support verification and validation (V&V) work throughout the system development life cycle. However, although the MBSE system model provides strong support for system construction, analysis, and optimization, the model itself cannot be used as the final deliverable of the project, especially in complex engineering projects involving multi-party cooperation and compliance requirements.

[0003] In industrial applications (such as aerospace, automotive, defense, etc.), design documents that meet industry standards and regulatory requirements are key deliverables during system development. These design documents are not only used for project acceptance, compliance review, and delivery, but also provide important references for subsequent system maintenance, upgrades, and product lifecycle management. Especially in highly regulated industries such as aerospace, documented design processes and verification processes are necessary to pass 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 and contains a large amount of multidimensional information, which needs to be presented in a clear and structured way to meet the needs of different audiences. Secondly, the system model is dynamic. As the system design is constantly updated, the documented content also needs to be consistent in real time. Traditional manual methods often cannot effectively cope with frequent model iterations and updates, which can easily lead to inconsistencies between documents and actual models. In addition, different design documents may need to extract different types of information from the system model, which makes template- or rule-based document generation solutions inflexible when faced with complex and diverse needs.

[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 standard design documents. This method can not only reduce the time and errors of manually generating documents, but also ensure 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: An automatic generation method based on a predefined document template is proposed in the prior art. Based on the predefined document template, the structure and attributes of the system model are extracted to automatically fill in the document template. It 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 writing and maintenance of templates requires a lot of manual intervention, which makes the generation process cumbersome and error-prone. In particular, when the system model is updated, the document content cannot be synchronized in time.

[0008] (2) Rule-based model-to-document conversion method: extract relevant information from the system model and convert it into a design document through pre-defined rules or mapping relationships. It 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 complicated. Especially when the system model changes frequently, it is difficult to ensure the accuracy and consistency of the design document content. The dynamic update of documents is difficult to automate, resulting in frequent inconsistencies between models and documents.

[0009] Therefore, it is necessary to design an automatic generation method from MBSE system models to design documents to solve the problems of poor flexibility and difficulty in dynamic synchronization of documents and models in the existing technology, realize the automatic generation and updating 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 the design document generation method based on templates and rules in the prior art, and difficulty in dynamic synchronization of documents and models, so as to ensure the consistency of the system model and the design document.

[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: Generate design document structure: Read 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; generate corresponding document chapters according to the process design content C, determine the order of 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 level B;

[0015] 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;

[0016] Step 4: Design dynamic updates of document content.

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

[0018] 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;

[0019] 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;

[0020] Generate the traceability table for the corresponding chapter in the design document according to the traceability relationship model;

[0021] 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.

[0022] Preferably, the requirement item table and the requirement item relationship table for the corresponding chapter in the design document are generated according to the requirement item model as follows:

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

[0024] 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;

[0025] 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, target requirement ID, which is used to represent the relationship between requirements.

[0026] Preferably, the table of corresponding chapters in the design document generated 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 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 from the corresponding row to the column;

[0028] 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;

[0029] 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.

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

[0031] 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 chapters are updated; wherein the detected contents include newly added components, newly added relationships, deleted components, deleted relationships, element renaming, hierarchy changes, layout changes in the graphical model, attribute value changes, and newly added or removed attributes.

[0032] Preferably, step 4 further includes a document integrity check:

[0033] After each design document is updated, 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.

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

[0035] Read the project name and automatically generate the document title;

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

[0037] 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.

[0038] Beneficial effects:

[0039] (1) Fully automated document generation: Most existing technologies rely on templates or rules to generate documents, which are less flexible and less automated. The present invention does not require the pre-writing of 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 has good flexibility, but also ensures the standardization and consistency of the design documents in terms of basic information, document structure, and document content, thus realizing a fully automated document generation process.

[0040] (2) Dynamic synchronization of documents and models: The existing technology has great difficulties in updating documents and models synchronously, especially when the model changes frequently. The present invention can synchronize document content in real time through the model change detection mechanism to ensure that the document always reflects 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 that are built based 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, structures, and behavior models. BRIEF DESCRIPTION OF THE DRAWINGS

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

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

[0044] Figure 3 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 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] Fig. 9 Based on Figure 8mTable is the table generated in the design document.

[0051] Fig.10 This is an example of a Table table.

[0052] Fig.11 Based on Fig.10 The table generated in the design document.

[0053] Fig.12 An example of a system architecture model.

[0054] Fig.13 Based on Fig.12 The system architecture model generates pictures and text in the design document. DETAILED DESCRIPTION

[0055] The present invention is described in detail below with reference to the accompanying drawings and embodiments.

[0056] The present invention provides an automatic generation method for supporting MBSE system models and design documents. The basic idea is that, first, the MBSE system model project information is read to automatically generate basic information of the design document. Then, based on the methodology model constructed in the model project, the design document structure is automatically generated. On this basis, the system model information is read to automatically generate the design document content. Finally, the integrity of the design document is checked and the document content is dynamically updated.

[0057] It can be seen that the present invention can dynamically generate design documents according to the structure and content of the MBSE system model, realizing a fully automated document generation process; it also synchronizes document content in real time through a model change detection mechanism to ensure that the document always reflects the latest system status.

[0058] Figure 1 The specific implementation steps of the method for automatically generating MBSE system models and design documents according to the present invention are shown as follows: Figure 1 As shown, the specific steps include:

[0059] Step 1: Read the MBSE system model project information and automatically generate basic information of the design document.

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

[0061] (1) Document name: Read the project name and automatically generate the document title.

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

[0064] (3) Modification time: Generate the modification time of the document based on the most recent modification record of the system model.

[0065] Ensure that documentation reflects the latest status of the model in a timely manner.

[0066] Step 2: Generate design document structure

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

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

[0069] Taking MagicGrid methodology as an example, the methodology model is as follows Figure 2 Read the design process sequence A in the MagicGrid methodology model, including:

[0070] The process in the black box of the problem domain: Start → Stakeholder Needs → Use Cases → System Context → Effectiveness Measurement;

[0071] The process in the problem domain white box: use case → functional analysis → system requirements, functional analysis → logical subsystem → effectiveness measurement;

[0072] Solve the process in the domain: logical subsystem → component structure → component parameters → end, component structure → component behavior → component requirements → end.

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

[0074] MagicGrid methodology design process content C includes: start, stakeholder needs, use cases, system context, effectiveness measurement, functional analysis, system requirements, logical subsystems, component structure, component parameters, component behavior, component requirements, and end.

[0075] For the design process corresponding model D, each design process is associated with the corresponding model, e.g. Figure 2 Stakeholders in the problem domain black box need to be associated with both the requirements management and diagram metamodel models.

[0076] (2) Generate a table of contents: Generate corresponding document chapters according to the process design 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.

[0077] 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, Effectiveness Measures, etc., to avoid errors and inconsistencies in manual settings.

[0078] Step 3: Generate design document content

[0079] 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.

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

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

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

[0083] 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;

[0084] 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.

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

[0086] According to the traceability relationship models such as design structure matrix (DSM), mTable (Mapping Table), Table, etc., the traceability relationship table exactly the same as that in the design document is automatically generated.

[0087] Among them, Figure 6 As shown, DSM uses a matrix to represent the relationship between elements. The first row and the first column of the matrix represent the elements in the model respectively. The diagonal part cannot be edited. The values ​​at the corresponding positions in the matrix represent the relationship type. The core steps of DSM generating the traceability relationship table in the design document 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 relationship between the model elements in the DSM to the middle part corresponding to the first row and the first column of the table. The values ​​at the corresponding positions in the table represent the relationship from the corresponding row to the column. The generated traceability relationship representation is, for example Figure 7 shown.

[0088] 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. Figure 8-Figure 9 .

[0089] Table uses columns as table items and rows as table item contents, and generates a completely corresponding table in the design document in a row-by-row and column-by-column manner. Figure 10-11 .

[0090] Through the above methods, the accuracy of the content and its correspondence with the model are ensured.

[0091] (3) Graphical content generation: The system architecture model generated using graphical modeling languages ​​such as SysML has pictures and text descriptions. These pictures and text are directly exported, and in the outline generated based on the methodology model, the exported pictures are automatically inserted into the corresponding position of the document, accompanied by a text description of the model name. For example, see Figure 12-13 . Fig.13 There are pictures on top and text below.

[0092] Step 4: Dynamic update of document content

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

[0094] (1) Automatically detect model changes: Every time a model changes, the system detects the changes and updates the content of the relevant sections. Updates include: adding new components, adding new modules, subsystems, components, etc.; adding new relationships, introducing new connections, interfaces or constraints, such as signal lines, physical connections, etc.; deleting components, removing modules or components that are no longer needed; deleting relationships, removing invalid or redundant interfaces and connections; renaming elements, modifying the names of modules, parameters, relationships or interfaces; changing the hierarchy, adjusting the hierarchy of modules in the system, such as decomposition and dissection; adjusting the position, changing the layout in the graphical model; changing the value of module or system attributes; adding or removing attributes of specific modules, etc.

[0095] (2) Document integrity check: After each design document update, the system automatically performs an integrity check, including checking whether the document chapter structure is completely consistent with the methodology model, checking whether the images and image 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 DSM, mTable, and Table traceability relationship model. If there is any inconsistency, the system outputs the inconsistent model name information on the console to ensure the consistency of the document content and structure and avoid omissions.

[0096] The above specific embodiments only describe the design principle of the present invention. The shapes and names of the components in the description may be different and are not limited. Therefore, those skilled in the art in the field of the present invention may modify or replace the technical solutions recorded in the above embodiments; and these modifications and replacements do not deviate from the creative purpose and technical solutions of the present invention and should all fall within the protection scope of the present invention.

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 design document structure: Read system design process information from the methodology model built 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; Generate corresponding document chapters according to the process design 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, characterized in that: 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 the traceability table for the corresponding chapter in the design document according to 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, characterized in that: The requirement item table and the 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, target requirement ID, which is used to represent the relationship between requirements.

4. The method for automatically generating MBSE system models and design documents according to claim 2, characterized in that: 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 from the corresponding row to the column; 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, characterized in that: The 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 chapters are updated; wherein the detected contents include newly added components, newly added relationships, deleted components, deleted relationships, element renaming, hierarchy changes, layout changes in the graphical model, attribute value changes, and newly added or removed attributes.

6. The method for automatically generating MBSE system models and design documents according to claim 5, characterized in that: The step 4 further includes a document integrity check: After each design document is updated, 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, characterized in that: The 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