Hierarchical Block Diagram Documentation Generation
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Current methods for generating code from block diagrams in electronic control units lack effective documentation, particularly for debugging and modification, requiring improved methods for generating flexible and user-friendly documentation text.
Innovation Solution
A computer-implemented method that automatically generates documentation from block diagrams by verifying documentation conditions, generating text for blocks, and utilizing a hierarchical structure, with options for customization and integration with simulation engines, filter scripts, and data definition tools.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Loss of information
If detailed documentation is generated for debugging and modification, then documentation completeness is improved, but documentation complexity increases
Solution Approach 1:
The documentation is segmented into multiple hierarchical levels corresponding to the block diagram structure. Each level documents only the blocks visible at that level, creating modular documentation sections that can be independently managed and understood, thus reducing overall complexity while maintaining completeness.
Solution Approach 2:
The patent introduces a hierarchical dimension to documentation organization. Instead of flat documentation, it creates multi-level documentation structures where each level corresponds to a specific hierarchical level in the block diagram, allowing detailed information to be organized systematically across dimensions.
2Productivity
If automated documentation generation is implemented, then productivity is improved, but documentation customization capability deteriorates
Solution Approach 1:
The documentation generation system is made dynamic by allowing users to select different hierarchical levels for documentation. The system can adaptively generate documentation at any desired level of detail, from high-level overviews to detailed block-level descriptions, maintaining both automation and flexibility.
Solution Approach 2:
The patent enables customization by allowing users to change parameters such as the hierarchical level of documentation, the types of information included, and the output format. These parameter changes allow the same automated system to produce different documentation variants suited to different needs.
3Manufacturing precision
If hierarchical block structure is documented in detail, then documentation precision is improved, but ease of operation deteriorates
Solution Approach 1:
By segmenting documentation into hierarchical levels, users can access only the level of detail they need for their current task. This segmentation makes the documentation easier to navigate and use, while the complete hierarchical structure ensures that precise detailed information is available when needed.
Data Source
AI summary
A method for generating a documentation of a program, the program being generated from one or more blocks of a block diagram in a technical computing environment, the one or more blocks of the program having at least one hierarchical block whose functionality is defined by a plurality of blocks in a subordinate hierarchical level of the block diagram. The method is carried out by a computer system having at least one processor, the processor opening the block diagram at a top hierarchical level in a model editor of the technical computing environment and verifying if a documentation condition is fulfilled for the current hierarchical level of the block diagram. When the documentation condition is fulfilled, the processor generates documentation text for the blocks in the current hierarchical level.