MDN/Projects/Development/Content Annotations: Difference between revisions
< MDN | Projects | Development
Jump to navigation
Jump to search
No edit summary |
m (Sheppy moved page MDN/Development/Annotations to MDN/Projects/Development/Content Annotations: Project plan doc reorg) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This is a proposed plan for a project to add annotation support to the MDN wiki powered by [https://github.com/mozilla/kuma/ Kuma]. | This is a proposed plan for a project to add annotation support to the MDN wiki powered by [https://github.com/mozilla/kuma/ Kuma]. It's a longer-term project; something we need, but isn't necessarily urgent. | ||
==Project statement== | ==Project statement== | ||
| Line 23: | Line 23: | ||
==Inspirations== | ==Inspirations== | ||
* http://hypothes.is/ - This is very, very similar to what we want, although we'd need to make changes to integrate it better into MDN. | * http://hypothes.is/ - This is very, very similar to what we want, although we'd need to make changes to integrate it better into MDN. To try it out, visit http://hypothes.is/alpha and create an account. | ||
* '''This page has several Hypothes.is annotations on it, so try it out.''' | |||
==Additional thoughts and requirements== | ==Additional thoughts and requirements== | ||
| Line 29: | Line 30: | ||
==Development resources== | ==Development resources== | ||
* | * Need to evaluate using Hypothes.is as a basis: http://hypothes.is/ | ||
==Next steps== | ==Next steps== | ||
* We should have the interested parties try out Hypothes.is and take notes so we can have a discussion about what we want here. | * We should have the interested parties try out Hypothes.is and take notes so we can have a discussion about what we want here. | ||
Latest revision as of 20:22, 19 June 2014
This is a proposed plan for a project to add annotation support to the MDN wiki powered by Kuma. It's a longer-term project; something we need, but isn't necessarily urgent.
Project statement
The goal of this project is to encourage more community involvement--and to improve our ability to collaborate--by adding support for annotating and commenting on all or part of a document on MDN.
Features desired:
- Ability to attach notes to a selected area of a document
- Ability to reply to those notes
- Ability to archive and/or delete notes
- Spam filtering
- Needs to be fully integrated into MDN, with no extra software required, and any logging into the service needs to use the same one as MDN itself
- Should be able to toggle the interface for annotations on and off
- Ability to "ping" people whose attention is needed
- Possible integration with the review request mechanism?
- Support for indicating when an annotation is no longer relevant (such as when its ideas are integrated into the article, or have been determined not to be relevant)
Goals
- Improve collaboration on MDN by making asynchronous discussions possible.
- Get more people invested in participating in the documentation process by letting them comment and add notes to articles if they're afraid to edit the content directly.
Inspirations
- http://hypothes.is/ - This is very, very similar to what we want, although we'd need to make changes to integrate it better into MDN. To try it out, visit http://hypothes.is/alpha and create an account.
- This page has several Hypothes.is annotations on it, so try it out.
Additional thoughts and requirements
Development resources
- Need to evaluate using Hypothes.is as a basis: http://hypothes.is/
Next steps
- We should have the interested parties try out Hypothes.is and take notes so we can have a discussion about what we want here.