search

linkeddata / dokieli

:bulb: dokieli is a clientside editor for decentralised article publishing, annotations and social interactions
https://dokie.li/
Other
789 stars 81 forks source link

Overview of more annotation user stories #148

Open csarven opened 8 years ago

csarven commented 8 years ago

Via: https://hypothes.is/blog/a-coalition-of-scholarly-annotators/

  • As an author of a paper, I want to invite a small group of colleagues to provide feedback.

✔ Handled with the Share notification.

  • As a pre-print publisher, I want to create and manage an overlay journal.

✗ Not of interest to dokieli development, but how dokieli is used eg https://linkedresearch.org/ based journal.

  • As a journal publisher, I want to implement a peer review system that brings authors and reviewers together in role-defined groups.

✔ Partly possible in dokieli. No explicit roles are assigned by the tooling, but rather ACL on an inbox which can receive annotations/reviews for select individuals/groups for any part of the document.

  • As a university librarian, I want students’ dissertations to be annotated openly so they carry forward an expectation that things should work that way.

✔

  • As a biomedical researcher, I want to use human curation of the literature to develop examples we can use to train our text mining algorithms.

✔/✗ I suspect that this is intended to be a top-down annotation. This is a todo in https://github.com/linkeddata/dokieli/issues/54 .

  • As a journal publisher, I want to create safe spaces for commentary so that authors and expert readers can participate comfortably.

+1 "safe space" is of interest, but unclear by this description. If based around ACL, Solid+dokieli covers this. If it is about whether who can annotate and whether those annotations are made visible without filtering, this is not yet handled. Currently, the owner of the inbox decides or has a chance to restrict the notifications, and annotations to be viewed thereafter.

  • As a vision-impaired user, I want annotation tools to be accessible to me.

+1. More ARIA https://github.com/linkeddata/dokieli/issues/24 on top of out of the box good accessibility practices?

  • As an annotator, I want to be able to assign DOIs to individual contributions, or to sets of them.

✔/✗ "DOI" is unclear whether it is a DOI string or an HTTP URL that happens to be doi.org. dokieli is interested in HTTP URIs and the contributor controls where they save their items. DOI string generation and/or registering is out of scope.

  • As an author, I want annotation to integrate with my preferred writing tool so that annotations can flow back into the text.

✔ If such tooling supports the Web Annotation vocabulary and able to send a notification to the inbox of a dokieli URI, it will work out of the box.

  • As a scientist, I want to participate in a journal club that travels around the web, annotating papers in many different publishing systems.

I think this is out of scope. Annotating in dokieli is not like genius/hypothes.is where the user could potentially annotate any type of document (PDF/HTML..) and have their annotation stored at a centralised service. dokieli annotation UI annotates articles that comes with the dokieli UI (the JavaScript essentially) and lets the annotator store wherever they have access to.

  • As an author, I want to annotate my own published work, noting errata and supplying new context.

✔

  • As an editor, I want to document key editorial decisions and expose them to the public.

✔/✗ This is a particular type of annotation (with motivation) I suppose. Created https://github.com/linkeddata/dokieli/issues/146 to include oa:editing.

  • As a scientist I want to annotate everywhere using my ORCID identity.

✔/✗ The requirement is that, ORCID needs to be used as a WebID and the profile needs to have an storage.

  • As a researcher, I want control over the annotations I make in various contexts so I can assemble this work into a coherent form and claim credit for it.

✔ Control? Yes, this is handled by placing the contribution at a location that one trusts and has ACL settings eg., posting the annotation on own website. dokieli can assign an ACL to an annotation.

  • As a publisher, I want to commission expert annotators whose commentary adds value to my content.

✔ This is about filtering or working with specific inboxes. Owner of the dokieli document can assign different inboxes for different parts of the document (if needed). The "experts" with certain ACL can notify that inbox about their annotation.

  • As a user, I want to be able to upvote or downvote annotations so I can help improve the quality of discussion.

+1. It'll be part of https://github.com/linkeddata/dokieli/issues/146 . PS: up/downvote doesn't "improve the quality of discussion". If anything, it is a lazy way of "contributing". Preference is to say something constructive or add more information. Any way..

  • As a funder, I want to bring grant reviewers together in private annotation spaces where discussion is tightly coupled to the documents they are reviewing.

✔ Is this a forum/commentary space where they can read each others' annotations for all articles? What's unique to it? Otherwise, this is already possible by the fact that one gets to see a review/annotation in context of the document if they have read permissions.

  • As publisher, I want to be able to review and moderate annotations in my own authoritative layer.

✔/✗ We might need a special way for the owner of the inbox to display the notifications and the annotations, and flex their superpowers over them. Those with write control can already delete a notification through the UI.

  • As an author, I want to be able to annotate and interconnect the references I cite.

✔/✗ Unclear about the "interconnect" part. Is this just about being able to annotate a citation? If so, it is not particularly different than how the annotations and citations currently works in dokieli.

  • As a publisher, I understand that readers may view my content through a variety of lenses, but I want to present my own annotation layer as the authoritative one.

+1 We can have different stylesheets. It can be covered in https://github.com/linkeddata/dokieli/issues/146 and https://github.com/linkeddata/dokieli/issues/147

  • As the developer of a journal publishing system, I want to deliver a bundled annotation service that integrates with my identity system.

Unclear. Out of scope. Probably of interest to https://linkedresearch.org/ and a particular way of using dokieli.

  • As a publisher, I want to project a curated view of a paper’s peer-review process onto the published paper.

I think this will be covered in https://github.com/linkeddata/dokieli/issues/41

rhiaro commented 8 years ago
  • As an author, I want to annotate my own published work, noting errata and supplying new context.

✔

But we're missing UI for making it clear / visually prioritising annotations by the author, and distinguishing types of annotation like errata.

*As a researcher, I want control over the annotations I make in various contexts so I can assemble this work into a coherent form and claim credit for it.

✔ Control? Yes, this is handled by placing the contribution at a location that one trusts and has ACL settings eg., posting the annotation on own website. dokieli can assign an ACL to an annotation.

✗ TODO: a tool/app for assembling and visualising publications and annotations. Ideally interoperable with but separate from dokieli.

  • As a publisher, I want to commission expert annotators whose commentary adds value to my content.

✔ This is about filtering or working with specific inboxes. Owner of the dokieli document can assign different inboxes for different parts of the document (if needed). The "experts" with certain ACL can notify that inbox about their annotation.

And 'share' to invite them of course.

up/downvote doesn't "improve the quality of discussion". If anything, it is a lazy way of "contributing"

Until we have AI to filter this for us, I think the 'lazy' crowd are an excellent way to mitigate against spam and junk, and thus "improve the quality of discussion".

✔/✗ We might need a special way for the owner of the inbox to display the notifications and the annotations, and flex their superpowers over them. Those with write control can already delete a notification through the UI.

+1, and related to the TODO above.

csarven commented 8 years ago

But we're missing UI for making it clear / visually prioritising annotations by the author, and distinguishing types of annotation like errata.

Replied earlier. Similar user story to the one on unique presentation of annotations. It can be covered in #146 and #147

✗ TODO: a tool/app for assembling and visualising publications and annotations. Ideally interoperable with but separate from dokieli.

We might be going on a tangent here but, this could be like a document/annotation view (similar to Google Drive). If this goes through, it'll probably be a separate application. Right now we have the resource-browser which sooooort of does this. We can extend resource-browser probably by fetching resources to see what type of documents they are eg. if they have schema:Article or oa:Annotation, then indicate that in the list or something.

csarven commented 2 months ago

See also https://csarven.ca/linked-research-decentralised-web#annotations