Flowchart Definition Language for Source Code Visualization
Find Innovative SolutionsGenerate Solutions
Solution Overview
Problem
Complex computer programs with source code spread across few engineers make it expensive and inefficient to modify or enhance existing code due to the risk of changing its behavior and introducing bugs, especially when subject matter experts leave a team, and existing methods like modularization and extensive comments are inefficient or inaccurate for understanding workflows.
Innovation Solution
A flowchart definition language is used to visualize and separate workflows from source code, allowing for the generation of flowcharts that can be converted into different programming languages, reducing dependency on specific languages or tools and enabling non-experts to understand complex logic.
Engineering Contradictions & Design Principles
Engineering Contradiction Analysis
1Reliability
If source code is used to implement complex workflows, then the functionality can be achieved, but the understandability and maintainability deteriorate as projects grow in size
Solution Approach 1:
The patent segments workflows from source code by introducing a separate workflow definition layer (e.g., YAML, JSON, or visual flowchart configurations) that independently describes workflow logic. This separation allows workflows to be defined, visualized, and maintained separately from the underlying code implementation, improving understandability without sacrificing correctness.
Solution Approach 2:
The patent introduces an intermediary workflow engine or interpreter that sits between the workflow definition and the source code execution. This intermediary translates high-level workflow definitions into executable operations, allowing non-experts to understand and modify workflows through intuitive definitions while the engine handles the complex code execution details.
2Loss of information
If extensive comments and documentation are added to source code to improve understanding, then more information is provided, but the complexity and maintenance burden increase
Solution Approach 1:
The patent creates a separate copy of the workflow logic in a simplified, visual, or configuration-based format that mirrors the source code workflow behavior. This workflow definition copy serves as both documentation and executable specification, eliminating the need for separate comments while providing complete workflow information in an easily consumable format.
Solution Approach 2:
The patent transitions workflow information from the one-dimensional source code space to another dimension through visual flowcharts, graphical interfaces, or structured configuration files. This dimensional shift allows workflow logic to be represented in a more intuitive format that is easier to understand and modify without adding complexity to the original code.
3Adaptability or versatility
If subject matter experts leave a team, then organizational changes occur, but the ability to understand and modify code is lost
Solution Approach 1:
The patent enables workflows to be self-documented and self-explanatory through visual representations and structured definitions that inherently convey their logic and purpose. Anyone can understand and modify workflows by reading the visual flowcharts or configuration files without needing to consult subject matter experts, making the system self-sufficient regarding knowledge transfer.
Solution Approach 2:
The patent performs preliminary documentation and knowledge capture by automatically generating visual workflow representations and detailed definitions from source code, or by requiring workflow definitions to be created before implementation. This preliminary action ensures that complete workflow knowledge is captured and stored in an accessible format before experts leave, preventing knowledge loss.
4Ease of manufacture
If modularization is used to separate workflows in source code, then code organization improves, but workflows remain difficult to visualize and understand
Solution Approach 1:
The patent adds a visual dimension to modularized workflows by generating flowcharts, graphical representations, or interactive diagrams from the modular code structure. This visual layer maintains the organizational benefits of modularization while providing intuitive workflow visualization that makes logic and flow easily detectable and understandable.
Data Source
AI summary
Source code can be converted into workflows and visualized. A flowchart definition language may be utilized for generating flowcharts representing the source code. Conversely, the visualization can be converted into source code using different languages.