To document or not to document? An exploratory study on developers’ motivation to document code

Yulia Shmerlin, Irit Hadar, Doron Kliger, Hayim Makabee

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

Abstract

Technical debt represents the situation in a project where developers accept compromises in one dimension of a system in order to meet urgent demands in other dimensions. These compromises incur a “debt”, on which “interest” has to be paid to maintain the long-term health of the project. One of the elements of technical debt is documentation debt due to under-documentation of the evolving system. In this exploratory study, our goal is to examine the different aspects of developers’ motivation to document code. Specifically, we aim to identify the motivating and hindering aspects of documentation as perceived by the developers. The motivating aspects of code documenting we find include improving code comprehensibility, order, and quality. The hindering aspects include developers’ perception of documenting as a tedious, difficult, and time consuming task that interrupts the coding process. These findings may serve as a basis for developing guidelines toward improving documentation practices and encouraging developers to document their code thus reducing documentation debt.

Original languageAmerican English
Title of host publicationAdvanced Information Systems Engineering Workshops - CAiSE 2015 International Workshops, Proceedings
EditorsAnne Persson, Janis Stirna
PublisherSpringer Verlag
Pages100-106
Number of pages7
ISBN (Electronic)9783319192420
DOIs
StatePublished - 2015
Event2nd International Workshop on Advances in Services Design based on the Notion of Capabiliy, ASDENCA 2015, 3rd International Workshop on Cognitive Aspects of Information Systems Engineering, COGNISE 2015, 1st International Workshop on Digital Business In... - Stockholm, Sweden
Duration: 8 Jun 20159 Jun 2015

Publication series

NameLecture Notes in Business Information Processing
Volume215

Conference

Conference2nd International Workshop on Advances in Services Design based on the Notion of Capabiliy, ASDENCA 2015, 3rd International Workshop on Cognitive Aspects of Information Systems Engineering, COGNISE 2015, 1st International Workshop on Digital Business In...
Country/TerritorySweden
CityStockholm
Period8/06/159/06/15

Keywords

  • Documentation
  • Motivation
  • Technical debt

All Science Journal Classification (ASJC) codes

  • Management Information Systems
  • Control and Systems Engineering
  • Business and International Management
  • Information Systems
  • Modelling and Simulation
  • Information Systems and Management

Fingerprint

Dive into the research topics of 'To document or not to document? An exploratory study on developers’ motivation to document code'. Together they form a unique fingerprint.

Cite this