GeekyNote: A Technical Documentation Tool with Coverage, Backtracking, Traces, and Couplings

Yung Pin Cheng, Wei Nien Hsiung, Yu Shan Wu, Li Hsuan Chen

Research output: Chapter in Book/Report/Conference proceedingConference contributionpeer-review

Abstract

Understanding an unfamiliar program is always a daunting task for any programmer, either experienced or inexperienced. Many studies have shown that even an experienced programmer who is already familiar with the code may still need to rediscover the code frequently during software maintenance. The difficulties of program comprehension is much more intense when a system is completely new. One well-known solution to this notorious problem is to create effective technical documentation to make up for the lack of knowledge.The purpose of technical documentation is to achieve the transfer of knowledge. However, creating effective technical documentation has been impeded by many problems in practice [1]. In this paper, we propose a novel tool called GeekyNote to address the major challenges in technical documentation. The key ideas GeekyNote proposes are: (1) documents are annotated to versioned source code transparently; (2) formal textual writings are discouraged and screencasts (or other forms of documents) are encouraged; (3) the up-to-dateness between documents and code can be detected, measured, and managed; (4) the documentation that works like a debugging-trace is supported; (5) couplings can be easily created and managed for future maintenance needs; (6) how good a system is documented can be measured. A demo video can be accessed at https://youtu.be/cBueuPVDgWM.

Original languageEnglish
Title of host publicationProceedings - 2020 ACM/IEEE 42nd International Conference on Software Engineering
Subtitle of host publicationCompanion, ICSE-Companion 2020
PublisherInstitute of Electrical and Electronics Engineers Inc.
Pages73-76
Number of pages4
ISBN (Electronic)9781450371223
DOIs
StatePublished - Oct 2020
Event42nd ACM/IEEE International Conference on Software Engineering: Companion, ICSE-Companion 2020 - Seoul, Korea, Republic of
Duration: 27 Jun 202019 Jul 2020

Publication series

NameProceedings - 2020 ACM/IEEE 42nd International Conference on Software Engineering: Companion, ICSE-Companion 2020

Conference

Conference42nd ACM/IEEE International Conference on Software Engineering: Companion, ICSE-Companion 2020
Country/TerritoryKorea, Republic of
CitySeoul
Period27/06/2019/07/20

Keywords

  • document coverage
  • document effectiveness
  • program documentation
  • technical documentation

Fingerprint

Dive into the research topics of 'GeekyNote: A Technical Documentation Tool with Coverage, Backtracking, Traces, and Couplings'. Together they form a unique fingerprint.

Cite this