Problem:
Currently, FigJam is an excellent tool for collaborative brainstorming and ideation. However, when transitioning from high-level conceptualization to more structured representations like flowcharts, sequence diagrams, or entity-relationship diagrams, users are often forced to switch to other tools or manually draw these complex diagrams, which is time-consuming, prone to errors, and difficult to maintain. This breaks the seamless flow from idea to implementation, creating a gap between the initial brainstorming phase and the detailed technical documentation or code implementation. The lack of text-based diagramming also limits the ability to easily version control diagrams or generate them programmatically.
Solution:
Integrate native support for Mermaid.js within FigJam. This would allow users to create various diagrams (flowcharts, sequence, class, state, ER, Gantt, etc.) directly using Mermaid's simple, Markdown-inspired syntax within a dedicated block or widget in FigJam.
Key features of this integration should include:
-
Dedicated Mermaid Block/Widget: A new option in the FigJam toolbar to insert a Mermaid diagram block.
-
Real-time Preview: As users type Mermaid syntax, the diagram should render in real-time, allowing for immediate visual feedback.
-
Syntax Highlighting and Error Checking: Basic syntax highlighting and immediate feedback on Mermaid syntax errors to aid creation.
-
Export Options: Ability to export the rendered Mermaid diagram as an image (PNG, SVG) from within FigJam.
-
Bidirectional Editing: The ability to edit the Mermaid text code from the rendered diagram and vice-versa, offering flexibility to users.
Benefits:
-
Seamless Transition from Brainstorm to Code:
-
Bridge the Gap: Enables a smooth transition from freeform ideation in FigJam to structured diagramming, directly laying the groundwork for code implementation. Designers, product managers, and developers can collaborate on flowcharts or system designs that can then be easily copied and used in documentation or code repositories.
-
"Diagrams as Code": Aligns with the "documentation as code" principle, allowing diagrams to be version-controlled alongside code, ensuring they remain up-to-date with project changes.
-
Reduced Friction: Eliminates the need to switch between multiple tools for different stages of the design and development process, saving time and improving efficiency.
-
-
Wide Industry Adoption and Compatibility:
-
Enterprise Standard: Mermaid.js has gained widespread adoption across major enterprises like GitHub and Microsoft, who have integrated it into their platforms (e.g., GitHub Markdown rendering, Visual Studio Code, SharePoint). This indicates its reliability and growing status as a de-facto standard for text-based diagramming.
-
Competitor Support: Other leading collaborative whiteboard tools, such as Miro, already offer Mermaid support (often via a marketplace app), demonstrating the demand and proven utility of this integration in similar environments.
-
Open Source & Active Community: Being an open-source project, Mermaid benefits from continuous development and a large, active community, ensuring its evolution and stability.
-
-
Enhanced Collaboration and Accessibility:
-
Collaborative Diagramming: Multiple team members can work on the same FigJam board and contribute to Mermaid diagrams simultaneously, facilitating real-time collaboration on technical specifications.
-
Accessible to Non-Designers: Text-based diagramming lowers the barrier to entry for non-designers (e.g., developers, product managers, business analysts) to create and contribute to clear visual representations, as they don't need extensive design tool experience.
-
LLM Compatibility: Large Language Models (LLMs) are increasingly trained on and capable of understanding, generating, and even interpreting Mermaid syntax. This means that future AI-powered features within Figma or integrated with FigJam could leverage Mermaid diagrams for advanced capabilities like generating code from diagrams, summarizing complex flows, or even correcting diagram logic, further enhancing productivity.
-
-
Improved Documentation and Maintainability:
-
Easy Updates: Modifying a diagram becomes as simple as editing a few lines of text, significantly faster than dragging and dropping elements in a graphical editor, especially for complex diagrams.
-
Readability: The text-based nature of Mermaid code makes diagrams readable and understandable even without rendering, which is beneficial for quick reviews and understanding diagram logic.
-