/
Policy

Policy

Owned by Lidiyo joshi
Apr 01, 2025

Purpose and Use


The purpose of Unified Diagrams for Jira is to enable users to create and display various types of diagrams, including Mermaid, Graphviz, and PlantUML, directly within Jira issues. This tool enhances the clarity of technical documentation, improves collaboration, and visualizes complex processes or systems in project management workflows.

Usage Guidelines:

  • Unified Diagrams for Jira should be used to create and display flowcharts, UML diagrams, graphs, and other visual diagrams directly in Jira issues, comments, and descriptions.

  • Diagrams are dynamically rendered from code stored within Jira custom fields.

  • Users must ensure that the diagrams adhere to project standards and enhance the communication of technical concepts.

 

Data Integrity

Accurate Diagram Representation:

  • Users are responsible for ensuring that the diagram code stored in Jira custom fields is correct and properly formatted.

  • Diagrams must comply with the specific syntax requirements of Mermaid, Graphviz, and PlantUML to ensure accurate rendering.

Avoidance of Redundant Fields:

  • Redundant or duplicate diagram fields should be avoided to maintain efficiency and consistency within Jira.

 

Data Privacy

No External Data Storage:

  • Unified Diagrams for Jira does not store any user data. All diagram code and rendering information are stored within Jira custom fields.

  • The plugin does not collect, process, or transmit any data outside the Atlassian environment.

Sensitive Information Handling:

  • Users must avoid storing sensitive or confidential information within diagram code.

  • Ensure compliance with organizational data privacy policies when using Unified Diagrams for Jira.

 

Access Control

Restricting Unauthorized Access:

  • Access to diagram custom fields should be controlled through Jira permissions and custom field access settings.

  • Only authorized users should be able to edit or modify diagram-related custom fields.

 

Compliance

Organizational Policies:

  • Usage of Unified Diagrams for Jira must comply with all relevant organizational policies regarding technical documentation and data management.

Data Protection Regulations:

  • Since no external data is stored or processed, the plugin complies with data protection best practices and regulatory standards.

Industry Standards:

  • The plugin complies with industry standards for diagramming, visual documentation, and project communication best practices.

 

Monitoring and Audit

Usage Monitoring:

  • Organizations should periodically review the usage of diagrams to ensure alignment with project needs and compliance guidelines.

Regular Audits:

  • Conduct regular audits of Jira custom fields containing diagrams to ensure correctness, update outdated content, and remove unnecessary diagrams.

 

Modification and Removal

Modification Procedures:

  • Follow Jira’s issue editing policies when modifying diagrams.

  • Any changes to diagrams should be reviewed and documented for traceability.

Removal of Unused Diagrams:

  • Unused or obsolete diagrams should be removed following standard Jira issue maintenance practices to maintain field cleanliness and avoid clutter.

 

Policy Review

Regular Review:

  • This policy will be reviewed periodically to ensure its continued relevance and effectiveness.

Policy Changes:

  • Any modifications to this policy will be communicated to relevant stakeholders and teams.