afv-library/skills/external-diagram-mermaid-generate/CREDITS.md

1.9 KiB

Credits & Acknowledgments

This skill was built upon established patterns in technical diagramming and Salesforce data modeling. The following concepts and conventions shaped its design.


Diagramming Concepts

Text-Based Diagramming

The skill uses Mermaid as its primary diagramming syntax, covering Entity Relationship Diagrams, sequence diagrams, and flowcharts. Key capabilities include:

  • Entity Relationship Diagram syntax
  • Sequence diagram patterns
  • Flowchart and state diagram support
  • Live rendering through Mermaid-capable renderers

An alternative syntax, PlantUML, informed the UML diagram patterns used in sequence and class diagrams.


Salesforce Domain Patterns

Data Modeling Conventions

The ERD conventions follow standard Salesforce object relationship patterns, including Master-Detail, Lookup, and External relationships as documented in the Salesforce platform's object model.

Integration Architecture

Integration sequence diagrams draw on widely-adopted API documentation patterns adapted for Salesforce's authentication and integration architecture.

Schema Reference

Object and field relationship information reflects standard Salesforce object reference conventions and relationship type definitions.


Key Concepts

ERD Notation

The Entity Relationship Diagram conventions follow standard database modeling patterns adapted for Salesforce relationships (Master-Detail, Lookup, External).

Sequence Diagram Patterns

OAuth flow and integration sequence diagrams follow UML 2.0 standards with Salesforce-specific adaptations.

Mermaid in Documentation

The approach of using Mermaid for inline diagrams in Markdown documentation is a widely-adopted pattern in technical documentation that enables version-controlled diagrams alongside code.

Color Accessibility

The color palette follows accessibility guidelines for color-blind-friendly design, using a pastel fill with high-contrast stroke approach.