diff --git a/_data/news.yml b/_data/news.yml index 97793c878..b0b9a6dd7 100644 --- a/_data/news.yml +++ b/_data/news.yml @@ -194,7 +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: Creating a data workflow" +- name: "New page: Creating a data-flow 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](creating_data_workflow). + description: This page guides you with capturing your planned data workflow in a diagram. [Discover the page here](creating_dataflow_diagram). diff --git a/_data/sidebars/data_management.yml b/_data/sidebars/data_management.yml index a82d207e8..9163b43fe 100755 --- a/_data/sidebars/data_management.yml +++ b/_data/sidebars/data_management.yml @@ -70,8 +70,8 @@ subitems: url: /compliance_monitoring - title: Costs of data management url: /costs_data_management - - title: Creating a data workflow - url: /creating_data_workflow + - title: Creating a data-flow diagram + url: /creating_dataflow_diagram - title: Data analysis url: /data_analysis - title: Data brokering diff --git a/pages/data_life_cycle/planning.md b/pages/data_life_cycle/planning.md index 5df939092..7874dc142 100644 --- a/pages/data_life_cycle/planning.md +++ b/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, creating_data_workflow] + your_tasks: [compliance, costs, dmp, data_security, dm_coordination, machine_actionability, creating_dataflow_diagram] training: - name: Training in TeSS registry: TeSS diff --git a/pages/your_tasks/creating_data_workflow.md b/pages/your_tasks/creating_dataflow_diagram.md similarity index 75% rename from pages/your_tasks/creating_data_workflow.md rename to pages/your_tasks/creating_dataflow_diagram.md index 037cf8c32..95c53f032 100644 --- a/pages/your_tasks/creating_data_workflow.md +++ b/pages/your_tasks/creating_dataflow_diagram.md @@ -1,26 +1,26 @@ --- -title: Creating a data workflow +title: Creating a data-flow diagram contributors: [Vilem Ded] -description: Best practices to capture your planned data workflow in a diagram. -page_id: creating_data_workflow +description: Best practices to capture your planned data-flow in a diagram. +page_id: creating_dataflow_diagram --- -## How should you draw a data workflow diagram? +## How to create a data-flow diagram? ### Description -Creating a data workflow diagram for your research project greatly enhances your data management process. -While [Data Management Plans (DMPs)](data_management_plan) can span tens or even hundreds of pages, a diagram offers a more concise and accessible way to represent your workflow. +Creating a data-flow diagram for your research project greatly enhances your data management process. +While [Data Management Plans (DMPs)](data_management_plan) can span tens or even hundreds of pages, a diagram offers a more concise and accessible way to represent your data-flow. 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. -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. +A well-crafted data-flow 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 -* A simple diagram can significantly improve clarity and communication and it's essential to first consider the complexity of the workflow. For complex project 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 is 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 simple diagram can significantly improve clarity and communication and it's essential to first consider the complexity of the data-flow. For complex project 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 data-flow, the more time and effort it will take to create and update the diagram. It is 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 may include sensitive or confidential information or reveal critical details that could be exploited by attackers, such as system vulnerabilities or data access points. Therefore, be cautious about sharing information 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. +* While a diagram is a helpful tool, it is usually not legally binding without a formal, written description of the data-flow. 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. It is 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 DMPs, the diagram is a living resource and should be updated as the research project progresses. @@ -51,5 +51,5 @@ A well-crafted workflow diagram also boosts the engagement of less-involved part * For dissemination, you can use a raster-graphics file format such as Portable Network Graphics (PNG) or other. * Use a vector graphics tool of your preference. * Open source: {% tool "draw-io" %}, {% tool "inkscape" %}, {% tool "libre-office-draw" %}. - * Licensed: MS Visio, Miro.com, Corel Draw, MS PowerPoint, Affinity Designer and Adobe Illustrator. + * Licensed: MS Visio, Miro.com, Corel Draw, MS PowerPoint, Affinity Designer or Adobe Illustrator. * Investigate your tool and all features it provides. E.g. {% tool "draw-io" %} allows you to host the diagram in {% tool "github" %} making it a very convenient tool for collaborative editing.