Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test Mermaid Diagrams for Visualizing System Relationships and AI Workflow #1

Open
NADOOITChristophBa opened this issue Sep 14, 2024 · 1 comment

Comments

@NADOOITChristophBa
Copy link
Member

Description:
We want to explore the use of Mermaid diagrams to visualize the relationships between systems in our applications. This experiment aims to determine if these diagrams can aid the AI chatbot in memory retention and planning. Additionally, we want to test if the diagrams can be used to:

  • Visualize which steps AI workers are executing in separate tasks.
  • Facilitate the definition of common interfaces among AI workers.
  • Provide a real-time overview of the current process step.

This approach could improve transparency for human users, allowing them to monitor AI activity and intervene if an AI is underperforming.

Tasks:

  • Integrate Mermaid diagrams into the AI prompts to visualize system relationships.
  • Test if these diagrams enhance the AI chatbot's memory and planning capabilities.
  • Implement Mermaid diagrams to track the AI workflow in real-time.
  • Assess the effectiveness of diagrams in showing progress and identifying potential AI failures.
  • Collect feedback on the visualization’s clarity and usability for human oversight.

Acceptance Criteria:

  • Successful integration of Mermaid diagrams into AI prompts.
  • Demonstrated improvement in AI memory retention or planning.
  • A functional visualization of AI workflow steps and interface definitions.
  • User feedback on the utility and effectiveness of the diagrams.
@NADOOITChristophBa
Copy link
Member Author

Here's a Mermaid diagram example that visualizes the relationship of systems in an application and the steps the AI workers might take. This diagram can be used as a starting point for what you want to include in the GitHub issue.

graph TD
    subgraph System_Relationships
        A[System A] --> B[System B]
        A --> C[System C]
        B --> D[System D]
        C --> D
    end

    subgraph AI_Workflow
        step1[AI Worker 1: Analyze Requirements]
        step2[AI Worker 2: Define Interfaces]
        step3[AI Worker 3: Implement Task]
        step4[AI Worker 4: Review & Validate]

        step1 --> step2
        step2 --> step3
        step3 --> step4
    end

    subgraph Progress_Tracking
        A1[Step 1: Requirements Analysis]
        A2[Step 2: Interface Definition]
        A3[Step 3: Task Implementation]
        A4[Step 4: Validation]

        A1 --> A2 --> A3 --> A4
    end

    %% Connect System Relationships with AI Workflow
    System_Relationships --> AI_Workflow

    %% Connect AI Workflow with Progress Tracking
    AI_Workflow --> Progress_Tracking
Loading

Explanation:

  • System Relationships: Shows how different systems (A, B, C, D) are connected.
  • AI Workflow: Visualizes the steps AI workers take to complete a task.
  • Progress Tracking: Maps out the high-level steps of the process, which can be used to show the current status of the workflow.

How to Use:

Include this code block in the GitHub issue. When rendered, it provides a clear visual representation of both system relationships and the AI workflow. This can help team members and stakeholders understand the process and monitor AI activities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant