Commit 80cce38e authored by Timm Schoening's avatar Timm Schoening
Browse files

Update Readme.md

parent e4ac0cec
......@@ -2,5 +2,13 @@
This is your starting point for exploring the MareHub AG V/I SOP documents. This readme provides some background and context information on how the SOPs are structured and how the data workflow is explained. It is like an SOP for SOPs.
![MareHub AG Videos/Images SOP documentation: general workflow](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/standard-operating-procedures/-/raw/master/SOPs/graphics/AGVI_SOP-documentation-1-workflow.jpeg "MareHub AG Videos/Images SOP documentation: general workflow")
SOPs generally describe how processes create or modify entities which are managed in infrastructure.
<img src="https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/standard-operating-procedures/-/raw/master/SOPs/graphics/AGVI_SOP-documentation-1-workflow.jpeg">
![MareHub AG Videos/Images SOP documentation: project workflow](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/standard-operating-procedures/-/raw/master/SOPs/graphics/AGVI_SOP-documentation-2-project-workflow.jpeg "MareHub AG Videos/Images SOP documentation: project workflow")
In terms of research data, this is expressed by a data creation process that produces a data set entity which is managed in a data repository.
![MareHub AG Videos/Images SOP documentation: project workflow with actors](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/standard-operating-procedures/-/raw/master/SOPs/graphics/AGVI_SOP-documentation-3-project-actors.jpeg "MareHub AG Videos/Images SOP documentation: project workflow with actors")
Processes are conducted by an actor - in this case researchers - and similarly infrastructure is operated by actors - in this case a research data management (RDM) team. Infrastructure is further characterized by whether it is publicly accessible and whether it is machine-accessible. Accessibility by humans is always expected.
![MareHub AG Videos/Images SOP documentation: project workflow with documentation](https://gitlab.hzdr.de/datahub/marehub/ag-videosimages/standard-operating-procedures/-/raw/master/SOPs/graphics/AGVI_SOP-documentation-3-project-documentation.jpeg "MareHub AG Videos/Images SOP documentation: project workflow with documentation")
Processes and entities can be accompanied by one or many documentation entities. These can take various forms, depending on use cases, SOPs, software tools used, etc. These documentation entities may be seen by some as just another data entity (_"one wo:mans data is another wo:mans metadata"_), we like to keep it separate. The format of the documentation entities (file format, information content, etc.) is defined by one or several actors. In case the file format is machine-readable, the documentation entity will be marked as such. Like data entities, documentation entities cannot be the end of a workflow. They needs to be further processed or be placed into an infrastructure. This infrastructure might also be access-restricted.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment