STATUS: IN DEVELOPMENT
Page development phases
While writing and reviewing it is important to keep in mind that the aim of the FAIR Metroline is to provide readers FAIRification guidance in an understandable and applicable way. Each page is designed to be user-friendly, with clear headings, concise language, and practical examples. After reading a page, a user should be able to understand the problem, take practical steps towards the solution, and and apply the FAIR principles to their own research projects. Pages go through the following development phases:
STATUS: FUTURE WORK: the page will be developed in the future.
STATUS: IN DEVELOPMENT: the page is or will soon be developed the Writing group. See Writing group for more information.
STATUS: READY FOR REVIEW: the page is ready to be reviewed by the Reviewing group. See Reviewing group for more information.
STATUS: RELEASED: The page has been formally released by the Editorial board. See Editorial Process for details.
Updates to status are made by the Editorial board.
Content of the FAIR Metroline
The FAIR Metroline is a Health-RI community effort, and decisions are driven by consensus among all contributors (writers, reviewers and editors).
The content of the FAIR Metroline will be periodically updated, based on contributions from the writers and reviewers. The Editorial board will ensure that the content represents the majority opinion and that the various perspectives of contributors are taken into account.
Kindly contact fairservicedesk@health-ri.nl if you consider any content to be incorrect.
Writing group
Contributing to the FAIR Metroline is a collaborative and structured process that ensures the content is accurate, comprehensive, and valuable. As part of the Writing group, you have full rights on the FAIR Metroline Confluence pages. Furthermore, you are added to the dedicated Slack channel. You will be mentioned in the Writers' section on the Contributors page.
As a writer, keep in mind the following:
You are expected to co-create pages.
You are expected to provide feedback on pages written by other members of the Writing group
To get a clear understanding of what is expected in each section of a FAIR Metroline page, study the template.
Adhere to the Style guide
Ensure the content you provide respects copyright by following the Copyright guidelines (TODO).
Suggested approach for writing a page
Brainstorming: Start with a braindump and add everything you can think of. Research your topic and look for existing best-practices in sources such as the FAIR Cookbook and RMDkit Turing way https://the-turing-way.netlify.app/index.html, DSW, FAIR Sharing.
Drafting: Add your text by mentioning your name between brackets, followed by the text. For example: [Sander] This is my text.
Draft a clear outline that structures the content logically. Include main headings and subheadings to organize the information.
Define the key messages and objectives for the page. What should readers learn or be able to do after reading the page?
Where appropriate, include examples, case studies, diagrams, or other visuals to illustrate points and enhance understanding.Collaboration: 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.
Notification: When the writers feel the page is ready, notify the Editorial board and they will start the feedback process.
Revisions: Resolve the provided feedback, ensure your page follows the Style guide and notify the Editorial board.
Reviewing group
The reviewing process for contributions is critical to ensure that content is accurate, reliable, and valuable to readers. This process involves multiple steps and participants, ensuring thorough evaluation and quality control.
As part of the Reviewing group, you have comment rights on the FAIR Metroline Confluence pages. You will be mentioned in the Reviewers' section on the Contributors page.
As a reviewer, keep in mind the following:
You are expected to review pages
The Editorial board will communicate with timeline when and which pages are available for review after the monthly board meeting.
Perform a preliminary check to ensure the draft meets basic requirements. This includes checking for references, visuals, adherence to the style guide, and basic formatting.
You can add suggestions by adding comments to a page. Please make sure the suggestions are constructive and respectful.
The suggestions will be addressed. This may include contacting you to further clarify/discuss a suggestion. Note that even though all suggestions will be taken seriously, not all will necessarily be adopted.
After the comments have been addressed, the Editorial Board updates the status.
To reduce expenses, the Editorial board regularly checks whether Confluence accounts are actively used and disables the inactive ones. To reactivate a disabled account, please send an email to fairservicedesk@health-ri.nl.
Editorial board
The Editorial board is responsible for the FAIR Metroline as a product. As a board member you:
Create and improve the processes around the FAIR Metroline
Keep track of the members of the Writing group and Reviewing group
Ensure contributors are in the correct group and have the appropriate rights in Confluence
Writing group members get full access rights
Reviewing group members get comment rights
Disable accounts of inactive members
Decide which pages are prioritised, aligned with the plateau planning
Keep track of the development stages of the pages and update the page’s status accordingly
Ensure that the Writing group provides feedback
Notifies the Reviewing group and others when pages are ready for review
Via email, websites and/or blog-posts, e.g. on the Health-RI website
Information includes a link to the How to contribute page
Ensure pages meet the quality standards:
Occasionaly update the Style guide
Check whether pages follow the Style guide
Occasionally check the pages for dead links
Members of the Editorial board have to be part of the Writing group. The board meets once per month.