Metroline: Template for adding details to a step

Owned by Jolanda Strubel
Last updated: Aug 08, 2024 by Sander de Ridder
2 min read

Goal: The template below is used to ensure all FAIR Metroline steps are detailed the same way. Please note that contributors are only mentioned on the general contributors page.

Short description 

Short, clear, understandable, general description of the Step. If possible this should be based on research and other accepted sources. The description should be readable for everyone.

Start the Short description with a quote from, for example a paper.

Why is this step important 

Explain why this step is an important step in the FAIRification process.

How to

The How to section should:

  • be split into easy to follow steps;

    • Step 1

    • Step 2

    • etc.

  • help the reader to complete the step;

  • aspire to be readable for everyone, but, depending on the topic, may require specialised knowledge;

  • be a general, widely applicable approach;

  • if possible / applicable, add (links to) the solution necessary for onboarding in the Health-RI National Catalogue;

  • aim to be practical and simple, while keeping in mind: if I would come to this page looking for a solution to this problem, would this How-to actually help me solve this problem;

  • contain references to solutions such as those provided by FAIR Cookbook, RMDkit, Turing way and FAIR Sharing;

  • contain custom recipes/best-practices written by/together with experts from the field if necessary. 

Expertise requirements for this step 

Describes the expertise that may be necessary for this step. Should be based on the expertise described in the Metroline: Build the team step.

Practical examples from the community 

Examples of how this step is applied in a project (link to demonstrator projects).  

Training

Add links to training resources relevant for this step. Since the training aspect is still under development, currently many steps have “Relevant training will be added in the future if available.”

Suggestions

Visit our How to contribute page for information on how to get in touch if you have any suggestions about this page.