skip to main content
10.1145/3631991.3632016acmotherconferencesArticle/Chapter ViewAbstractPublication PageswsseConference Proceedingsconference-collections
research-article

LinkDoc: An Automated Process in the Delivery of Documentation in a Global Software Development Environment

Published:26 December 2023Publication History

ABSTRACT

Documentation, among the phases of software development, is a crucial step for product acceptance, given that poorly made documentation can compromise product quality. In the context of mobile development, it is not always easy to deal with the rise in the number of released devices, the new technologies and specifications, the frequent updates to the Android operating system and the lack of experience of the people responsible for the development itself. Considering this, the authors of this paper conducted an experiment aiming to assist the development of technical documentation, reducing the time spent preparing and raising the degree of reliability in this information. Through simulations in a controlled environment, a group of employees were able to utilize this new approach to prove its efficiency. The automation of this process shows a reduction of up to 33.2%, that is, 10.3 hours less in the documentation’s total execution time. Furthermore, this paper shows that it is possible to raise the reliability of information, since the average error rate shown is around 5.3%. However, for employees who have an average experience level in the team (between 6 and 18 months), the error rate is under 1.7%. In a setting where one must deal with adverse variables, such as new employees, off-standard databases, a rise in demand, among others, those values are substantially satisfactory and the new process becomes essential for the team.

References

  1. 2008. IEEE Standard for Software and System Test Documentation. IEEE Std 829-2008 (2008), 1–150. https://doi.org/10.1109/IEEESTD.2008.4578383Google ScholarGoogle ScholarCross RefCross Ref
  2. Emad Aghajani, Gabriele Bavota, Mario Linares-Vásquez, and Michele Lanza. 2019. Automated documentation of android apps. IEEE Transactions on Software Engineering 47, 1 (2019), 204–220.Google ScholarGoogle ScholarDigital LibraryDigital Library
  3. Emad Aghajani, Csaba Nagy, Olga Lucero Vega-Márquez, Mario Linares-Vásquez, Laura Moreno, Gabriele Bavota, and Michele Lanza. 2019. Software documentation issues unveiled. In 2019 IEEE/ACM 41st International Conference on Software Engineering (ICSE). IEEE, 1199–1210.Google ScholarGoogle ScholarDigital LibraryDigital Library
  4. Douglas Almendro 2019. OERTrust: um framework para aferição de confiabilidade em recursos educacionais abertos baseado em testes de software. (2019).Google ScholarGoogle Scholar
  5. Hualter O Barbosa, Witalo CX Albuquerque, Alexandre I Bandeira, Luiz H Albuquerque, Ueslei E Pivoto, Fernando B Pires, and Bruno A Bonifacio. 2020. Developing a release management tool to support global software development: an experience report on Android platform. In Proceedings of the 15th International Conference on Global Software Engineering. 117–121.Google ScholarGoogle ScholarDigital LibraryDigital Library
  6. Antonio Brígido, Camilo Souza, Fedrik Moura, Marcelo Reis, and Andre Neto. 2021. An Industrial Case Study on Applying Software Testing Automated in Global Software Development Environment. In 23rd International Conference on Global Software Engineering and Technology on January, 28-29, 2021 at New York, USA (2021). 1456–1459.Google ScholarGoogle Scholar
  7. Raquel FV Cunha, Fernanda BS Souza, Franciney O Lima, and Bruno A Bonifacio. 2020. How do newcomers learn work process in global software development (GSD)? a survey study from the perspective of newly project leaders. In Proceedings of the 15th International Conference on Global Software Engineering. 71–75.Google ScholarGoogle ScholarDigital LibraryDigital Library
  8. Marcio Delamaro, Mario Jino, and Jose Maldonado. 2013. Introdução ao teste de software. Elsevier Brasil.Google ScholarGoogle Scholar
  9. Daniel Galin. 2018. Software Testing. 255–317. https://doi.org/10.1002/9781119134527.ch14Google ScholarGoogle ScholarCross RefCross Ref
  10. Golara Garousi, Vahid Garousi-Yusifoğlu, Guenther Ruhe, Junji Zhi, Mahmoud Moussavi, and Brian Smith. 2015. Usage and usefulness of technical software documentation: An industrial case study. Information and software technology 57 (2015), 664–682.Google ScholarGoogle Scholar
  11. Kenish Rajesh Halani, Kavita, and Rahul Saxena. 2021. Critical Analysis of Manual Versus Automation Testing. In 2021 International Conference on Computational Performance Evaluation (ComPE). 132–135. https://doi.org/10.1109/ComPE53109.2021.9752388Google ScholarGoogle ScholarCross RefCross Ref
  12. Mike Hinchey. 2018. Seven Principles of Software Testing. 202–207. https://doi.org/10.1002/9781119174240.ch11Google ScholarGoogle ScholarCross RefCross Ref
  13. Hussam Hourani, Ahmad Hammad, and Mohammad Lafi. 2019. The impact of artificial intelligence on software testing. In 2019 IEEE Jordan International Joint Conference on Electrical Engineering and Information Technology (JEEIT). IEEE, 565–570.Google ScholarGoogle ScholarCross RefCross Ref
  14. Arif Ali Khan, Jacky Keung, Mahmood Niazi, Shahid Hussain, and Awais Ahmad. 2017. Systematic literature review and empirical investigation of barriers to process improvement in global software development: Client–vendor perspective. Information and Software Technology 87 (2017), 180–205.Google ScholarGoogle ScholarDigital LibraryDigital Library
  15. Rayfran Rocha Lima, Oswald Ekwoge, Bruno Bonifácio, Raquel Cunha, Hualter Barbosa, and Ana Carolina Oran Rocha. 2021. Overcoming Knowledge-Sharing Barriers that Affect Software Quality: An Experience Report. In XX Brazilian Symposium on Software Quality. 1–9.Google ScholarGoogle ScholarDigital LibraryDigital Library
  16. Anshita Malviya. 2019. Software testing: Concepts and issues. In Proceedings of 2nd International Conference on Advanced Computing and Software Engineering (ICACSE).Google ScholarGoogle ScholarCross RefCross Ref
  17. Marcelo Marinho, Rafael Camara, and Suzana Sampaio. 2021. Toward unveiling how safe framework supports agile in global software development. IEEE Access 9 (2021), 109671–109692.Google ScholarGoogle ScholarCross RefCross Ref
  18. Karl Meinke, Fei Niu, and Muddassar Sindhu. 2012. Learning-based software testing: a tutorial. In Leveraging Applications of Formal Methods, Verification, and Validation: International Workshops, SARS 2011 and MLSC 2011, Held Under the Auspices of ISoLA 2011 in Vienna, Austria, October 17-18, 2011. Revised Selected Papers. Springer, 200–219.Google ScholarGoogle Scholar
  19. Fathima Naja Musthafa, Syeda Mansur, and Adika Wibawanto. 2020. Automated Software Testing on Mobile Applications: A Review with Special Focus on Android Platform. In 2020 20th International Conference on Advances in ICT for Emerging Regions (ICTer). 292–293. https://doi.org/10.1109/ICTer51097.2020.9325445Google ScholarGoogle ScholarCross RefCross Ref
  20. Arnaldo Gil de Souza Sardella NASCIMENTO. 2019. Ameaças à validade de artigos que empregam métodos empíricos em testes de aplicações construídas para ambiente web. Ph. D. Dissertation.Google ScholarGoogle Scholar
  21. Chadatarn Raksawat and Pattama Charoenporn. 2021. Software testing system development based on ISO 29119. Journal of Advances in Information Technology 12, 2 (2021).Google ScholarGoogle ScholarCross RefCross Ref
  22. Mário Romao, Joao Costa, and Carlos J Costa. 2019. Robotic process automation: A case study in the banking industry. In 2019 14th Iberian Conference on information systems and technologies (CISTI). IEEE, 1–6.Google ScholarGoogle ScholarCross RefCross Ref
  23. Guoping Rong, Zefeng Jin, He Zhang, Youwen Zhang, Wenhua Ye, and Dong Shao. 2019. DevDocOps: towards automated documentation for DevOps. In 2019 IEEE/ACM 41st International Conference on Software Engineering: Software Engineering in Practice (ICSE-SEIP). IEEE, 243–252.Google ScholarGoogle ScholarDigital LibraryDigital Library
  24. Ian Sommerville. 2011. Software engineering (ed.). America: Pearson Education Inc (2011).Google ScholarGoogle Scholar
  25. Marcello Visconti and Curtis R Cook. 2002. An overview of industrial software documentation practice. In 12th International Conference of the Chilean Computer Science Society, 2002. Proceedings. IEEE, 179–186.Google ScholarGoogle ScholarCross RefCross Ref

Index Terms

  1. LinkDoc: An Automated Process in the Delivery of Documentation in a Global Software Development Environment
            Index terms have been assigned to the content through auto-classification.

            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
              WSSE '23: Proceedings of the 2023 5th World Symposium on Software Engineering
              September 2023
              352 pages
              ISBN:9798400708053
              DOI:10.1145/3631991

              Copyright © 2023 ACM

              Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than the author(s) must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected].

              Publisher

              Association for Computing Machinery

              New York, NY, United States

              Publication History

              • Published: 26 December 2023

              Permissions

              Request permissions about this article.

              Request Permissions

              Check for updates

              Qualifiers

              • research-article
              • Research
              • Refereed limited
            • Article Metrics

              • Downloads (Last 12 months)17
              • Downloads (Last 6 weeks)8

              Other Metrics

            PDF Format

            View or Download as a PDF file.

            PDF

            eReader

            View online with eReader.

            eReader

            HTML Format

            View this article in HTML Format .

            View HTML Format