MDN/Projects/Development/Content Annotations: Difference between revisions
< MDN | Projects | Development
Jump to navigation
Jump to search
(Created page with "This is a proposed plan for a project to add annotation support to the MDN wiki powered by [https://github.com/mozilla/kuma/ Kuma]. ==Project statement== The goal of this pro...") |
No edit summary |
||
Line 12: | Line 12: | ||
# 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 | # 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 | # 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== | ==Inspirations== | ||
Line 20: | Line 28: | ||
==Development resources== | ==Development resources== | ||
* We can almost certainly base this off of Hypothes.is: 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. |
Revision as of 19:30, 10 October 2013
This is a proposed plan for a project to add annotation support to the MDN wiki powered by Kuma.
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.
Additional thoughts and requirements
Development resources
- We can almost certainly base this off of Hypothes.is: 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.