Adamite is a browser plugin that supports annotating web resources, such as documentation. Currently, Adamite works on the Chrome web browser running on a desktop computer (not on phones or tablets).
With Adamite, you can keep track of what you find out and learn while using the documentation. To help make keeping track of annotations easier, we have developed different annotation types so you can categorize your notes into open questions, issues, to-do items, or general notes and highlights. For example, you can annotate your questions about a confusing part of the documentation with a question annotation, which will be pinned so you can access it on any page – when you find an answer down the road, you can answer the annotation with the content that answered your question.
You can also share these notes with teammates, using Adamite’s group feature. In a group, your annotations will be shared with other Adamite users in the group, so you can all see and respond to one another's' annotations. This way, you can see what your teammates have been learning and can help if they have a question or issue with some confusing documentation.
With a community of developers using Adamite, you can see other peoples’ public annotations. Save yourself time by seeing what other people found out was problematic, incorrect, or useful in the pages and pages of documentation. Navigating through many pages of documentation is also often cumbersome, so Adamite supports multiple anchors so you can connect all the parts that are relevant to you.
Once you have a whole bunch of annotations, you can use the Adamite website to curate your annotations. The website supports mass deleting, pinning, tagging, and sharing of annotations, so you can make your annotations better and share them with others easily.
The Chrome extension is currently in the development stage as part of the Natural Programming Project.
Contact us here to discuss Adamite, or through our user form!
Amber Horvath, Michael Liu, River Hendriksen, Connor Shannon, Emma Paterson, Imtiaz Rahman, Kazi Jawad, Andrew Macvean, and Brad Myers.
Amber Horvath, Michael Xieyang Liu, Connor Shannon, River Hendriksen, Kazi Jawad, Lai Wei, Andrew Macvean, and Brad A. Myers. "Understanding How Programmers Can Use Annotations on Documentation" In Proceedings of the 2022 CHI Conference on Human Factors in Computing Systems (CHI '2022). ACM. New Orleans, LA, April 30 - May 5, 2022. Read the paper here.
This work is funded by NSF grant "Personalizing API Documentation" (award CCF-2007482) and Google.
Any opinions, findings and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect those of the National Science Foundation or any other sponsor.