Use Cases and User Stories
- Critiquing a document (e.g. revising a license or text)
- Discussing a document (to develop understanding)
- Adding critical notes to a document
Gradually being transferred to this spreadsheet. ([T] indicates items that have been transferred to spreadsheet)
-
Create, read and update annotations inline on the document - HH[T] -
Purge annotations - HH[T] -
Authorization for annotations -- only user (or sysadmin) can edit/delete versus free-for-all. Also for classes - either have the ability to add specific people to a group who can edit (more work for the page admin, but more explicit), or have an unguessable edit link which is distinct from a read link (like google docs when you share to edit versus read). Edit permissions should be revokable (though i wouldn't conside the latter a huge immediate priority). [DONE][T] -
Identity for authors of annotations -- ie. authors are identified and stored in the annotation system [DONE][T] -
List recent annotations (by document and overall) [DONE][T] - pretty print (with annotations) [T]
- Threaded annotations (discussion thread) - H [Put on hold -> L] [T]
- Rate annotations (or just "like"/vote up/down) - L [moved into toolbar - No 8 Github]
Tag annotationsDisplay annotations by taglimit displayed annotations by usersearch annotationsAccess to annotation data - this would let us build the dashboard as a separate module - H (for P2PU)Provide installation instructions / package - this doesn't need to be a one-click installer, but a set of instructions on how to set up a self-hosted platform. [Documentation - H]- A "embed annotation" widget? I don't know if this is possible - but would be fantastic if a user with the right permissions could drop this into a blog post to turn the post into an annotatable document without having to worry about server. Rather than bringing their documents to us (or to commentit) - the widget would bring annotator to them.
For p2pu courses, I imagine course coordinators would love the ability to display metrics about different users. This relates to 8b above (show annotations for specific users), but for assessment, it would be nice to have a dashboard that shows number of annotations by user, by time (probably a graph here would be awesome).
Currently if i understood the docs correctly you do need to be able to inject the annotator into the page, which means, in general, you need to be in charge of the page to annotate it. It would be nice to be able to annotate any page. You could then imagine course participants writing, say a blog post, and their peers annotating it with feedback.
Markup.io does this nicely, but it's very coarse. But it's a really neat tool and their workflow could make sense for something like this. From a UI standpoint, some combination between that and those url shortener sites that display sort of like a control bar at the top of the page and then the "real" page in some kind of iframe could be cool. That plus a browser extension that you click to generate that page (again, like Markup.io) would be slick.
The ability to export annotation data to json or csv for arbitrary archiving or visualization would be great for p2pu metrics especialy, but also just for posterity and extensiblity. Could consider giving each annotation page an activity stream via RSS which publishes comments in a conveniently consumable fashion as well.
User comes to a page:
- They cannot see annotations for which they do no have read permission
- Then cannot see options to edit or delete annotations on which they do not have relevant permission
- When creating an annotation, if logged in, they can set 'anyone can edit', 'anyone can read' checkboxes which set relevant permissions.