| Status | ||||
|---|---|---|---|---|
|
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 accountsmall group responsible for the FAIR Metroline processes
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 FAIR 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:
: the page is or will soon be developed by people from the Writing Groupgroup. See the Writing Process section for suggestions on how to write a page.Status colour Red title STATUS: IN DEVELOPMENT If contributing in this stage, you’re a writer. This means you are part of the Writers in the contributors page. Writing Group.
group for more information.
: when the Writing Group is satisfied with the page , it is ready to be reviewed by the Reviewing Groupgroup. See the (External) Reviewing Process section for details.Status colour Yellow title STATUS: READY FOR REVIEW If contributing in this stage, you’re a reviewer. This means you are part of the Reviewers in the contributors page. Reviewers Group.
Reviewing group for more information.
: The page has been formally released by the Editorial board. See Editorial Process for details.Status colour Green title STATUS: Released
Decisions regarding whether a page is ready to move to the next development stage are decided by the Editorial board. See Editorial board for more information.
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
The FAIR Metroline is a Health-RI community effort, and decisions are driven by consensus among all contributors (writers, reviewers and editors). No single contributor or editor owns the content of the site, or has the right to dictate what the content should be.
...
Kindly contact fairservicedesk@health-ri.nl if you consider any content to be incorrect.
Writing group
Acknowledgement of contributors
Contributors, if possible with their ORCID, are shown at the bottom of most pages. All contributors are also displayed on the contributors page (TODO).
The Writing Process
Contributor responsibilities
When contributing to the FAIR Metroline keep in mind the following: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 review pages written by other members of the Writing group
.Status colour Red title STATUS: IN DEVELOPMENT To get a clear understanding of what is expected in each section of a Metroline page, study the template.
Please adhere to the Style guide.
Please follow the Copyright guidelines to ensure the content you provide respects copyright (TODO).
Please make sure you comply to the Editors checklist (TODO).
Please make sure you acknowledge everyone involved in your contribution in the contributors' section of a page, after receiving their permission.
Suggested approach for writing a page:
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.
Add your text by mentioning your name between brackets, followed by the text. For example: [Sander] This is my text.
Co-write with members from the Writing Groupgroup. Some of us meet every Friday in Utrecht to co-write, but feel free to plan co-write sessions whenever you deem suitable.
When you feel the page is ready, notify the Writing Group group to make the page available for internal review.
The Writing Group reviewers can either directly edit the page or add comments with suggested improvements.
When development of the internal review page is completedone, notify the Editorial board. The board will verify the page will be made available for the (External) Review Group - see The (External) Review Process for more information.
The (External) Review Process
...
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
...
meets the requirements, update the page’s status and inform the Reviewing group.
Reviewers group
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 within the time frame of 3 weeks
The Editorial board will communicate if pages are available for review after the monthly board meeting.
You can add suggestions by adding comments to a page. Please make sure the suggestions are constructive and respectful.
After the review deadline has passed, the original Writing Group authors will address the suggestions. This may include contacting the reviewer 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 decides whether the page is ready to be released/adopted
Editorial Board Process
Decides which FAIR Metroline pages are ready to be released ?
Ensures pages reflect the majority opinion
Ensures pages use a consistent style throughout
Ensures pages do not contain dead links
The Editorial board will convene once per two months (???).
To reduce expenses, the Editorial board regularly checks whether a Confluence account is actively used and, if not, will disable the account.
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 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 have priority
Ensure page development is in line with the plateau planning
Are allowed to change the status of a page (e.g. from In progress to Ready for review)
Spread information when pages are ready for review via email, websites and/or blog-posts
Information includes a link to the “How to contribute” page
Ensure pages follow the Style guide
Occasionally check the pages for dead links
Members of the Editorial board are part of the Writing group and therefore substantively (???) involved. The board meets once per month.
TBD:
Outreach, the page is reviewed by a broad community
Bij de outreach kunnen referen naar de How to contribute. Hier staat ook een (link naar) het formulier (of gewoon een mailtje?)
Formulier voor aanmaken met wat vragen:
Wie ben ik en wat wil ik (Writing, Reviewing, Editorial Board)
Bij Writing → volledige rechten (je krijgt ook emails en wordt deel van slack groep voor communicatie etc.)
Bij Reviewing → comment rechten (krijgen mail voor het reviewen)
Formulier met Make a quick suggestion (zie RDMkit)
...
Keep for now:
Co-create. This includes the feedback from the writing team
Outreach, the page is reviewed by a broad community
Bij de outreach kunnen referen naar de How to contribute. Hier staat ook een (link naar) het formulier (of gewoon een mailtje?)
Formulier voor aanmaken met wat vragen:
Wie ben ik en wat wil ik (Writing, Reviewing, Editorial Board)
Bij Writing → volledige rechten (je krijgt ook emails en wordt deel van slack groep voor communicatie etc.)
Bij Reviewing → comment rechten (krijgen mail voor het reviewen)
Formulier met Make a quick suggestion (zie RDMkit)
Editorial board
Houdt zicht op de Writers en Reviewers
Als een reviewer niet bijdraagt, dan kan zijn/haar account worden gedeactiveerd
Small group, initially part of writing group
Gaat over het product FAIR Metroline
Style guide, de processen die er omheen zitten
Je moet hiervoor dus ook inhoudelijk betrokken zijn
Sturen het proces
welke pagina’s prio hebben
de mails naar buiten en de berichten op webpagina’s
de status van de pagina’s
de rollen van de mensen (inhoud van de groepen) + rechten in confluence
dat het klopt met de plateau planning
Old stuff
Acknowledgement of contributors
Contributors, if possible with their ORCID, are shown at the bottom of most pages. All contributors are also displayed on the contributors page (TODO).
: the page is or will soon be developed the Writing group. See the Writing Process section for suggestions on how to write a page.Status colour Red title STATUS: IN DEVELOPMENT If contributing in this stage, you’re a writer. This means you are part of the Writers in the contributors page. Writing Group.
: when the Writing group is satisfied with the page, it is ready to be reviewed by the Reviewing group. See the Reviewing process section for details.Status colour Yellow title STATUS: READY FOR REVIEW If contributing in this stage, you’re a reviewer. This means you are part of the Reviewers in the contributors page. Reviewers Group.
: The page has been formally released by the Editorial board. See Editorial Process for details.Status colour Green title STATUS: Released