Casdoc

Casdoc is a novel authoring technique and presentation format to create code examples with embedded annotations for the web. Each Casdoc document focuses on a complete code example. Additional explanations of the code are shown in annotations around the code. Readers can dynamically reveal, hide, move, and resize annotations based on the information they need. Authors insert these annotations in code files directly, and Casdoc automatically transforms annotated code files into web documents.

• See what Casdoc documents look like: Look at the annotated code examples from the book Introduction to Software Design with Java, 2nd Edition
• Try Casdoc for yourself: Create your own documents from annotated Java files, using the online transformation tool.
• Watch the demonstration video on YouTube: https://www.youtube.com/watch?v=Tze4M8Vl6ZE

Publications

• Mathieu Nassif and Martin P. Robillard. "A Field Study of Developer Documentation Format". Late Breaking Work Paper. Extended Abstracts of the ACM CHI Conference on Human Factors in Computing Systems, article 7, 7 pages, 2023.
  show bibtex

  @inproceedings{NassifR2023,
    author = {Nassif, Mathieu and Robillard, Martin P.},
  	booktitle = {Extended Abstracts of the ACM CHI Conference on Human Factors in Computing Systems},
  	title = {A Field Study of Developer Documentation Format},
  	articleno = {7},
  	numpages = {7},
  	year = {2023},
  	doi = {10.1145/3544549.3585767}
  }

• Mathieu Nassif, Zara Horlacher, and Martin P. Robillard. "Casdoc: Unobtrusive Explanations in Code Examples". Research Demonstration. In Proceedings of the 30th IEEE International Conference on Program Comprehension, 631-635, 2022.
  show bibtex

  @inproceedings{NassifHR2022,
    author = {Nassif, Mathieu and Horlacher, Zara and Robillard, Martin P.},
    booktitle = {Proceedings fo the 30th IEEE International Conference on Program Comprehension},
    title = {Casdoc: Unobtrusive Explanations in Code Examples},
    year = {2022},
    pages = {631--635},
    doi = {10.1145/3524610.3527875}
  }

Contributors

Casdoc is a project developed by Mathieu Nassif and Martin Robillard at McGill University, with past contributions from Zara Horlacher and Emily Shannon.