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 9 Next »

STATUS: IN DEVELOPMENT

This page describes the process of developing a FAIR Metroline page from its initial state to a released version. Sections “Ownership of content”, “Acknowledgement of contributors” and “Contributor’s responsibilities” are based on RDMkit’s How to contribute page.

Group Structure

The FAIR Metroline is being developed by the following groups:

  • Writing group: people actively co-writing pages

  • Reviewing group: a broader audience providing feedback on pages

  • Editorial board: ensure that the content represents the majority opinion and that the various perspectives of contributors are taken into account

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

Page Development Phases

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. Pages go through the following development phases:

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

  • STATUS: READY FOR REVIEW: when the Writing Group is satisfied with the page, it is ready to be reviewed by the Reviewing Group. See the (External) Reviewing Process section for details.

  • STATUS: ADOPTED: The page has been formally adopted by the Editorial board. See Editorial Process for details.

Since the content of these pages will be dynamic and revisions will be made, statuses will switch over time, even after a step has been adopted. 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.

Ownership of content

No single contributor or editor owns the content of the site, or has the right to dictate what the content should be. The content on the Metroline is a community effort, with many people contributing. Decisions are driven by consensus among the contributors and editors.

The content is periodically updated, which means that if you create content in a Metroline page, others can change the content without notifying you. However, the Metroline editors ensure that content is only modified for good reasons. The Metroline editors try to ensure that the legitimate concerns and different point of views of all contributors are accommodated, and that the content reflects the most popular consensus on any given topic.

If you find any content unsatisfactory, please feel free to send an email to fairservicedesk@health-ri.nl.

Acknowledgement of contributors

Contributors will be shown at the bottom of the page. If possible, please link contributors to their ORCID. All contributors will also be displayed in the contributors page.

The Writing Process

Contributor responsibilities

When contributing to the Metroline keep in mind the following:

  • To get a clear understanding of what is expected on each Metroline page, study the template.

  • For the sake of consistency, please follow our style guide.

  • It is your responsibility to make sure that the content you provide respects copyright. Please follow our Copyright guidelines (TODO).

  • To avoid having to resolve many issues during the revision process, please check the Editors checklist and make sure you have complied with the requirements. (TODO)

  • If others were involved in your contribution, by writing up or by providing resources such as diagrams or links, please make sure you acknowledge them in the contributors’ section of your page, after receiving their permission.

Suggested approach for writing a page:

  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 Writing 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 Writing Group.

    1. The Writing Group reviewers can either directly edit the page or add a comment with the suggested improvement.

  4. When the internal review is complete, the page will be made available for the (External) Review Group - see The (External) Review Process for more information.

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 original Writing Group authors will address the suggestions. This may include contacting the reviewer to further clarify/discuss a suggestion. Note 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