draft of data workflow diagram task

_data/news.yml

@@ -194,3 +194,7 @@
   date: 2024-10-24
   linked_pr: 1526
   description: The page is enriched with additional links and a bibliography. [Discover the page here](human_pathogen_genomics).
+- name: "New page: Data workflow diagram"
+  date: 2024-12-06
+  linked_pr: 1528
+  description: This page guides you with capturing your planned data workflow in a diagram. [Discover the page here](data_workflow_diagram).

_data/sidebars/data_management.yml

@@ -96,6 +96,8 @@ subitems:
         url: /storage
       - title: Data transfer
         url: /data_transfer
+      - title: Data workflow diagram
+        url: /data_workflow_diagram
       - title: Documentation and metadata
         url: /metadata_management
       - title: Ethical aspects

pages/data_life_cycle/planning.md

@@ -4,7 +4,7 @@ page_id: plan
 description: Introduction to data management planning.
 contributors: [Siiri Fuchs, Korbinian Bösl, Minna Ahokas, Federico Bianchini, Flora D'Anna]
 related_pages: 
-  your_tasks: [compliance, costs, dmp, data_security, dm_coordination, machine_actionability]
+  your_tasks: [compliance, costs, dmp, data_security, dm_coordination, machine_actionability, data_workflow_diagram]
 training:
   - name: Training in TeSS
     registry: TeSS

pages/your_tasks/data_workflow_diagram.md

@@ -0,0 +1,54 @@
+---
+title: Data workflow diagram
+contributors: [Vilem Ded]
+description: Best practices to capture your planned data workflow in a diagram.
+page_id: data_workflow_diagram
+related_pages: 
+dsw:
+faircookbook:
+---
+
+## How should you draw a data workflow diagram?
+
+### Description
+
+Creating a data workflow diagram for your research project greatly enhances your data management process. While Data Management Plans (DMPs) can span tens or even hundreds of pages, a diagram offers a more concise and accessible way to represent your workflow. This visual approach helps bridge the gap between partners who may have varying perceptions and levels of understanding, ensuring everyone is aligned. Diagrams make it easier to identify potential issues by highlighting undocumented data sources or destinations that might otherwise go unnoticed in a lengthy document. Additionally, these visual representations are invaluable during discussions and planning sessions, sparking deeper conversations and encouraging collaboration. A well-crafted workflow diagram also boosts the engagement of less-involved partners or stakeholders, giving them a clear and intuitive way to contribute to the planning process.
+
+### Considerations
+
+* Even a simple diagram can significantly improve clarity and communication, but it's essential to first consider the complexity of the workflow. If the process is straightforward and can be easily described in a single paragraph, a diagram might not be necessary. However, for more complex workflows with multiple steps, data sources, or stakeholders, a diagram is invaluable for identifying steps, dependencies, potential issues and ensuring everyone has a shared understanding.
+* The more complex the workflow, the more time and effort it will take to create and update the diagram. It’s important to plan carefully and ensure that the time invested in diagram creation and updates is manageable and that your contribution is clearly recognized.
+* A diagram can include sensitive or confidential information or reveal critical details that could be exploited by attackers, such as system vulnerabilities or data access points.  So be cautious about sharing it publicly. Ensure that appropriate security measures are in place and such information is properly protected to prevent security breaches.
+* While a diagram is a helpful tool, it is usually not legally binding without a formal, written description of the workflow. It’s good practice to complement your diagram with a full textual annex to ensure the process is well-documented and understood.
+* Content of the diagram will depend on many factors. Its good practice to start with definition of the targeted audience (project partners, data managers, funders, public) and main purpose (capturing life of project data, clarification of data protection framework​, description of pre-processing steps). Based on the targeted audience and purpose, you can then more precisely define the scope of your diagram, i.e. what (not) to include. These can be physical assets and entities (partners/people, storage locations, instruments, datasets, documents) or logical elements of your project (processes, data types, partner roles).
+* Same as DMP, the diagram is a living resource and should be updated as the research project progresses.
+
+### Solution
+
+* Start with simple top level diagram​. Share it and get feedback on what can be refined.
+
+* You can follow these steps.
+  1. List all assets.
+  2. List all partners and actors​.
+  3. List all processes​.
+  4. Define data sources​ - such as instrument, patient, collaborator, lab.
+  5. Define final data locations (sinks)​ - for example, archives, repositories, external processes, ingestion zones.
+  6. Start drawing visual elements representing the outer interface (sources and sinks) and move inwards.
+  7. Iteratively refine the diagram based on items which were not yet included.
+
+* Too complex diagrams can be split. Define sub-processes and detect input/output flows or interfaces.
+* Various attributes of visual elements can be mapped to aesthetics. These can be:
+  * square for process performed automatically vs. rectangle for process performed manually (shape);
+  * red line for sensitive data flow vs. blue for non-sensitive data (line color);
+  * color, fill, border.
+* Be consistent in mapping of aesthetics. For example, instead of using fill colors to depict encryption status (red vs blue) and collaborator's roles (green for researchers vs blue for contractors), you can use small key icon for the encryption status (shape).
+* Include legend if the aesthetics is complicated.
+
+* Don't forget to include date of last update, version and your name.
+
+* Source files for the diagrams should be vector based to facilitate portability and reuse. For example, Scalable Vector Graphics (SVG).
+* For dissemination, you can use a raster-graphics file format such as Portable Network Graphics (PNG) or other.
+* Use vector graphics tool of your preference.
+  * open source: [Draw.io](https://www.drawio.com/), [Inkscape](https://inkscape.org/), [Libre Office Draw](https://www.libreoffice.org/discover/draw/).
+  * licensed: MS Visio, Miro.com, Corel Draw, MS PowerPoint.
+* Investigate your tool and all features it provides. E.g. Draw.io allows you to host the diagram in {% tool "github" %} making it very convenient tool for collaborative editing.