Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

STATUS: IN DEVELOPMENT

Introduction

This page describes the process of developing a FAIR Metroline page from its initial state to an adopted, widely accepted version.

While writing and reviewing it is important to keep in mind that the aim of the Metroline is to provide readers FAIRification guidance in an understandable and applicable way. After reading a page a user should be able to understand the problem and take practical steps towards the solution.

Group Structure

The Metroline is being developed by the following groups of people:

  • Writing group: consists of people actively co-writing pages

  • Reviewing group: a broader audience providing feedback on the pages

  • Editorial Board: has the final word in deciding whether a page is ready to be released/adopted

We invite you to collaborate with us as we continue to refine the various FAIR Metroline phases. If you are interested in joining one of the groups, please email fairservicedesk@health-ri.nl

Page Development Phases

  • STATUS: IN DEVELOPMENT: The page is or will soon be developed by people from the Working Group. See The Writing Process for suggestions on how to write a page.

  • STATUS: READY FOR WG REVIEW: The page is ready for internal review by the Working Group.

  • STATUS: READY FOR REVIEW: When the Working Group is satisfied with the page, it is ready to be reviewed by the Review Group. See The (External) Reviewing Process for further details.

  • STATUS: ADOPTED: The page has been adopted. This is decided by the Editorial Board. See The Editorial Board Process for further details.

Bare in mind that even after a step has been adopted, it can still go back to in development when a step need to be revised. The most recent version will always be the visible one; if an adopted version also exists, the most recent version will contain a link to the adopted version at the top of the page.

The Writing Process

The Metroline pages are based on a template. Read more about the template and what is expected for each paragraph here.

Suggested approach:

  1. Start with a braindump - e.a. add everything you can think of. Research your topic. Look for existing best-practices in e.g. the FAIR Cookbook and RMDkit.

    1. Add your text by writing e.g. [Sander] This is my text

  2. Co-write with members from the working group. Some of us meet every Friday in Utrecht to co-write, but feel free to plan co-write sessions whenever you deem suitable.

  3. When done, make the page available for internal review and notify the Working Group

    1. Working Group Reviewers can either directly edit the page or add a comment with the suggested improvement

  4. Next, the Review Group will add comments/suggestions

    1. The original writers should address these comments. See The (External) Review Process for more information.

While writing, keep in mind:

  • The general description of page:

    • Should be readable for everyone and based on research

  • The how-to section of a page:

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

    • Should be a general, widely applicable approach

    • If possible / applicable also add (links to) the solution necessary for onboarding in the Health-RI National Catalogue.

    • Keep it practical and simple. Keep 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.

The (External) Review Process

Once a page has passed the Working Group’s review, it will be made available for review by the broader Review Group:

  • A page will be available for review for 3 weeks, starting the first Monday of a month

  • One week prior to a page being made available for review, we will send an email to the Review Group

  • After the 3 weeks have passed, the Working Group will address the suggestions. This may include contacting the reviewer to further clarify/discuss a suggestion. Bear in mind that even though all suggestions will be taken seriously, not all will necessarily be adopted.

  • After the suggestions have been addressed, the Editorial Board decides whether the page is ready to released/adopted

Editorial Board Process

  • The Editorial board will convene once per two months (???).

  • The Review Board decide whether pages that have been reviewed can move to the Adopted state.

  • No labels