Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
bedroesb committed Dec 6, 2024
1 parent c887dcf commit 029ee57
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pages/your_tasks/creating_data_workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ page_id: creating_data_workflow
### 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.
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.
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.
Expand All @@ -22,11 +22,11 @@ A well-crafted workflow diagram also boosts the engagement of less-involved part
* 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.
* 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 DMP, the diagram is a living resource and should be updated as the research project progresses.
* Same as DMPs, 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.
* Start with a simple top level diagram​. Share it and get feedback on what can be refined.

* You can follow these steps.
1. List all assets.
Expand All @@ -42,14 +42,14 @@ A well-crafted workflow diagram also boosts the engagement of less-involved part
* 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.
* Be consistent in mapping the 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 icons for the encryption status (shape).
* Include a legend if the aesthetics is complicated.

* Don't forget to include date of last update, version and your name.
* Don't forget to include the 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 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.
* Investigate your tool and all features it provides. E.g. {% tool "draw-io" %} allows you to host the diagram in {% tool "github" %} making it very convenient tool for collaborative editing.
* 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.

0 comments on commit 029ee57

Please sign in to comment.