skip to main content
10.1145/3275245.3275248acmotherconferencesArticle/Chapter ViewAbstractPublication PagessbqsConference Proceedingsconference-collections
research-article

A Study on Identification of Documentation and Requirement Technical Debt through Code Comment Analysis

Authors Info & Claims
Published:17 October 2018Publication History

ABSTRACT

Context: The TD concept reflects the challenging decisions that developers and managers need to take to achieve short-term benefits to keep the customers satisfied and to survive in a competitive market. The identification of technical debt (TD) is an important step to effectively manage TD items and make TD manageable and explicit to keep the amount of TD under control. Researchers have developed automated approaches to identify TD items using indicators derived from source code metrics. However, those indicators do not always point to TD that developer teams consider real problems and cannot identify many types of relevant TD. Objective: This work seeks to identify comment patterns and their relationships which can support the identification process of documentation and requirement debts. Method: We performed a qualitative and quantitative analysis to investigate acceptable patterns of comments which indicate the existence of documentation and requirement debts. Results: We classify factors which can impact on the detection automated of documentation and requirement debts. Besides, the performed study provided a set of new patterns to detect documentation and requirement debts. Conclusion: This research contributes to bridge the gap between the TD identification area and code comment analysis, successfully using code comments to detect documentation and requirement debts.

References

  1. L. Peters, "Technical debt: The ultimate antipattern - The biggest costs may be hidden, widespread, and long term," in Proceedings - 2014 6th IEEE International Workshop on Managing Technical Debt, MTD 2014, 2014, pp. 8--10. Google ScholarGoogle ScholarDigital LibraryDigital Library
  2. N. Rios, M. Gomes, D. M. Neto, and R. Oliveira, "A tertiary study on technical debt: Types, management strategies, research trends, and base information for practitioners," Inf. Softw. Technol., vol. 102, no. February, pp. 117--145, 2018.Google ScholarGoogle ScholarCross RefCross Ref
  3. E. Maldonado, E. Shihab, and N. Tsantalis, "Using Natural Language Processing to Automatically Detect Self-Admitted Technical Debt," IEEE Trans. Softw. Eng., vol. PP, no. 99, pp. 1--1, 2017.Google ScholarGoogle Scholar
  4. P. Avgeriou, P. Kruchten, I. Ozkaya, and C. Seaman, "Managing Technical Debt in Software Engineering," Dagstuhl Reports, vol. 6, no. 4, pp. 110--138, 2016.Google ScholarGoogle Scholar
  5. E. Tom, A. Aurum, and R. Vidgen, "An exploration of technical debt," J. Syst. Softw., vol. 86, no. 6, pp. 1498--1516, 2013. Google ScholarGoogle ScholarDigital LibraryDigital Library
  6. R. Spínola, N. Zazworka, C. Seaman, and F. Shull, "Investigating Technical Debt Folklore," 5th Int. Work. Manag. Tech. Debt, pp. 1--7, 2013. Google ScholarGoogle ScholarDigital LibraryDigital Library
  7. Q. Huang, E. Shihab, X. Xia, D. Lo, and S. Li, "Identifying self-admitted technical debt in open source projects using text mining," ESEM, 2017. Google ScholarGoogle ScholarDigital LibraryDigital Library
  8. Z. Li, P. Liang, P. Avgeriou, and N. Guelfi, "A Systematic Mapping Study on Technical Debt and its Management," J. Syst. Softw., vol. 101, pp. 193--220, 2014. Google ScholarGoogle ScholarDigital LibraryDigital Library
  9. N. S. R. Alves, T. S. Mendes, M. G. Mendonça, R. O. Spínola, F. Shull, and C. Seaman, "Identification and Management of Technical Debt: A Systematic Mapping Study," Inf. Softw. Technol., vol. 70, pp. 100--121, 2016. Google ScholarGoogle ScholarDigital LibraryDigital Library
  10. N. S. R. Alves, T. S. Mendes, M. G. de Mendonça, R. O. Spínola, F. Shull, and C. Seaman, "Identification and management of technical debt: A systematic mapping study," Inf. Softw. Technol., vol. 70, pp. 100--121, 2016. Google ScholarGoogle ScholarDigital LibraryDigital Library
  11. T. S. Mendes, D. A. Almeida, N. S. R. Alves, R. O. Spínola, and M. Mendonça, "VisMinerTD - An Open Source Tool to Support the Monitoring of the Technical Debt Evolution using Software Visualization," in 17th International Conference on Enterprise Information Systems, 2015. Google ScholarGoogle ScholarDigital LibraryDigital Library
  12. N. Zazworka, R. O. Spinola, A. Vetro', F. Shull, and C. Seaman, "A Case Study on Effectively Identifying Technical Debt," in Proceedings of the 17th International Conference on Evaluation and Assessment in Software Engineering - EASE '13, 2013, pp. 42--47. Google ScholarGoogle ScholarDigital LibraryDigital Library
  13. M. A. de F. Farias, J. A. Santos, M. Kalinowski, M. Mendonça, and R. Spínola, "Investigating the Identification of Technical Debt through Code Comment Analysis," in Enterprise Information Systems, Springer International Publishing, 2017, pp. 284--309.Google ScholarGoogle Scholar
  14. W. Maalej and H.-J. Happel, "Can Development Work Describe Itself?," in 7th IEEE Working Conference on Mining Software Repositories (MSR), 2010, pp. 191--200.Google ScholarGoogle Scholar
  15. M. A. D. F. Farias, M. G. D. M. Neto, A. B. Da Silva, and R. O. Spinola, "A Contextualized Vocabulary Model for identifying technical debt on code comments," in 2015 IEEE 7th International Workshop on Managing Technical Debt, MTD 2015 - Proceedings, 2015, no. ii, pp. 25--32.Google ScholarGoogle Scholar
  16. A. Potdar and E. Shihab, "An Exploratory Study on Self-Admitted Technical Debt," in IEEE International Conference on Software Maintenance and Evolution, 2014, pp. 91--100. Google ScholarGoogle ScholarDigital LibraryDigital Library
  17. W. Cunningham, "The WyCash portfolio management system," in Addendum to the Proceedings on Object-oriented Programming Systems, Languages, and Applications, 1992, no. October, pp. 29--30. Google ScholarGoogle ScholarDigital LibraryDigital Library
  18. C. Izurieta, A. Vetrò, N. Zazworka, Y. Cai, C. Seaman, and F. Shull, "Organizing the technical debt landscape," 3rd Int. Work. Manag. Tech. Debt, MTD 2012 - Proc., pp. 23--26, 2012. Google ScholarGoogle ScholarDigital LibraryDigital Library
  19. N. Brown et al., "Managing technical debt in software-reliant systems," in Proceedings of the FSE/SDP workshop on Future of software engineering research - FoSER '10, 2010, p. 47. Google ScholarGoogle ScholarDigital LibraryDigital Library
  20. G. Bavota and B. Russo, "A large-scale empirical study on self-admitted technical debt," in Proceedings of the 13th International Workshop on Mining Software Repositories - MSR '16, 2016, pp. 315--326. Google ScholarGoogle ScholarDigital LibraryDigital Library
  21. M. Farias, M. Colaço, R. O. Spínola, and M. G. D. M. Neto, "Identifying Technical Debt through Code Comment Analysis," in Doctoral Consortium on Enterprise Information Systems, 2016, no. Dceis, pp. 9--14.Google ScholarGoogle Scholar
  22. J. L. Freitas, D. Da Cruz, and P. R. Henriques, "A comment analysis approach for program comprehension," Proc. 2012 IEEE 35th Softw. Eng. Work. SEW 2012, pp. 11--20, 2012. Google ScholarGoogle ScholarDigital LibraryDigital Library
  23. E. S. Maldonado and E. Shihab, "Detecting and Quantifying Different Types of Self-Admitted Technical Debt," in 7th International Workshop on Managing Technical Debt, 2015, pp. 9--15.Google ScholarGoogle Scholar
  24. M. A. de F. Farias, A. B. Silva, M. G. de Mendonça, R. O. Spínola, and M. Kalinowski, "Investigating the Use of a Contextualized Vocabulary in the Identification of Technical Debt: A Controlled Experiment," in 18Th International Conference on Enterprise Information System - ICEIS, 2016, vol. 1, no. Iceis, pp. 369--378. Google ScholarGoogle ScholarDigital LibraryDigital Library
  25. V. R. Basili and D. M. Weiss, "A Methodology for Collecting Valid Software Engineering Data," IEEE Trans. Softw. Eng., vol. SE-10, no. 6, pp. 728--738, 1984. Google ScholarGoogle ScholarDigital LibraryDigital Library
  26. R. Van Solingen and E. Berghout, "The Goal Question Metric Method: a Practical Guide for Quality Improvement of Software Development," no. April, p. 217, 1999.Google ScholarGoogle Scholar
  27. F. Shull, J. Singer, and D. Sjoberg, Guide to Advanced Empirical Software Engineering. Springer, 2008. Google ScholarGoogle ScholarCross RefCross Ref

Index Terms

  1. A Study on Identification of Documentation and Requirement Technical Debt through Code Comment Analysis

      Recommendations

      Comments

      Login options

      Check if you have access through your login credentials or your institution to get full access on this article.

      Sign in
      • Published in

        cover image ACM Other conferences
        SBQS '18: Proceedings of the XVII Brazilian Symposium on Software Quality
        October 2018
        384 pages
        ISBN:9781450365659
        DOI:10.1145/3275245

        Copyright © 2018 ACM

        © 2018 Association for Computing Machinery. ACM acknowledges that this contribution was authored or co-authored by an employee, contractor or affiliate of a national government. As such, the Government retains a nonexclusive, royalty-free right to publish or reproduce this article, or to allow others to do so, for Government purposes only.

        Publisher

        Association for Computing Machinery

        New York, NY, United States

        Publication History

        • Published: 17 October 2018

        Permissions

        Request permissions about this article.

        Request Permissions

        Check for updates

        Qualifiers

        • research-article
        • Research
        • Refereed limited

        Acceptance Rates

        Overall Acceptance Rate35of99submissions,35%

      PDF Format

      View or Download as a PDF file.

      PDF

      eReader

      View online with eReader.

      eReader