Peer review in Ketida 2
Context
We need to facilitate peer review in Ketida 2. I will outline the ideal process as well as an MVP process.
Ideally Peer review would entail:
- Peer reviewers are invited to join the system to review certain books or components within books
- Peer reviewers can log in to the system if they want to accept the invite to review, and can see the books they've been invited to
- Peer reviewers accept the invite on a per component basis
- Once the invite is accepted the component is locked (cannot be edited) and only peer reviewers can leave comments
- Peer reviewers leave anonymised comments on components and then submit an overall review in a review form per component
- Book owners and book collaborators with edit access can see the review comments within each component and can respond to them, and can also see the review forms submitted per component
- The next steps in this process to revise the content, and to store and/or resolve peer reviews need to be outlined in more detail
Peer review requires at a minimum:
- Peer reviewers can log in (generated access credentials could be provided to them, to keep them anonymous)
- Peer reviewers can access the content they need to review (the generated access credentials could be assigned to the book's team with a new role 'reviewer', this role is the same as read access except they have access to a 'Submit review' button)
- The component is not editable while the peer reviewer is inside the component (using the existing chapter locks mechanism)
- The peer reviewer can leave comments on the component (commenting functionality needs to be added), their name appears as 'Reviewer 1' for example because their access credentials were not set up with their actual name
- The peer reviewer can click 'Submit review' (new button required, possibly floating at the bottom of each component) to open up the review form
-
The peer reviewer can add comments to the review form and provide a general recommendation as well as attach supplementary files
-
Book owners and book collaborators with edit access can see comments on the component (commenting functionality needs to be added)
-
Book owners and book collaborators with edit access can see peer review forms that have been submitted (new UI to view peer reviews needs to be designed)
-
The next steps in this process to revise the content, and to store and/or resolve peer reviews need to be outlined in more detail
Proposal
- Add commenting
- Add a new 'Submit review' button to each component
- Add a review form that opens when the 'Submit review' is clicked
- Add a new role 'peer reviewer' who has the same as view access except they can also see the 'Submit review' button and can submit reviews
- Add a way for book owners and collaborators with edit access to see the submitted reviews
- Add a way to resolve and archive reviews (if required)
Design
Implementation (if applicable)
[A description of the steps to implement the feature.]
Alternative approaches (if applicable)
[Include any alternatives to meet this use case.]
Open issues (if applicable)
[Links to and a discussion of related issues, if applicable.]