Text writing and clean code production
two realities of the same process in engineering students
DOI:
https://doi.org/10.1590/1983-3652.2023.41439Keywords:
Computer programming, Written language, Engineering educationAbstract
The quality of software products depends to a large extent on the ability of developers to generate clean code since they allow increasing the software life cycle. Therefore, it is crucial to improve the pedagogical practices of teaching programming, in particular, the ability of students to write quality code. However, the literature does not recognize comprehensive pedagogical models that guide the development of this writing ability, as observed in text redaction. This paper relates the production of clean code with the conceptions of the writing process in Computer Engineering students. Thereby, we used three practical assessments to evaluate the process of clean code programming on university students to later relate the results with the perceptions about writing that this group has. Results show a relationship between performance in programming tasks and the cohort and a positive correlation between the production of clean code and conceptions about writing. We conclude that our study opens a transdisciplinary collaboration. It can advance towards a pedagogical model to guide the teaching of clean code writing that contributes to higher quality software products.
Downloads
References
ALCOVER, R y col. Análisis del rendimiento académico en los estudios de informática de la Universidad Politécnica de Valencia aplicando técnicas de minerı́a de datos. In: XIII Jornadas de Enseñanza Universitaria de la Informática (JENUI 2007). Teruel, España.: [s.n.], 2007. p. 163-170. Disponible en: http://bioinfo.uib.es/~joemiro/aenui/procJenui/Jen2007/alanal.pdf.
ANICHE, Maurı́cio y col. Code smells for model-view-controller architectures. Empirical Software Engineering, Springer, v. 23, n. 4, p. 2121-2157, 2018. DOI: 10.1007/s10664-017-9540-2. Disponible en: https://link.springer.com/article/10.1007/s10664-017-9540-2.
BASTÍAS, Oscar Ancán; DÍAZ, Jaime y RODRÍGUEZ, Cristian Olivares. Evaluation of Critical Thinking in Online Software Engineering Teaching: A Systematic Mapping Study. IEEE Access, IEEE, p. 167015-167026, 2021. DOI: 10.1109/ACCESS.2021.3135245. Disponible en: https://ieeexplore.ieee.org/abstract/document/9648189.
BECKER, Brett A y QUILLE, Keith. 50 years of cs1 at sigcse: A review of the evolution of introductory programming education research. In: PROCEEDINGS of the 50th acm technical symposium on computer science education. [S.l.: s.n.], 2019. p. 338-344. DOI: 10.1145/3287324.3287432.
BEREITER, Carl y SCARMALIA, Marlene. Dos modelos explicativos de los procesos de composición escrita. Journal for the Study of Education and Development, Infancia y Aprendizaje, Fundación Infancia y Aprendizaje, n. 58, p. 43-64, 1992. DOI: 10.1080/02103702.1992.10822332. Disponible en: https://www.tandfonline.com/doi/abs/10.1080/02103702.1992.10822332.
BRONCKART, Jean-Paul. Actividad verbal, textos y discursos:: por un interaccionismo socio-discursivo. [S.l.]: Fund. Infancia y Aprendizaje, 2004.
BROWN, WJ; MALVEAU, RC y col. Architectures. anti-patterns: refactoring software and projects in crisis. [S.l.]: John Wiley y Sons, 1998.
CALLE-ARANGO, Lina y ÁVILA REYES, Natalia. Obstacles, facilitators, and needs in doctoral writing: A systematic review. Studies in Continuing Education, Taylor & Francis, p. 1-19, 2022. DOI: 10.1080/0158037X.2022.2026315. Disponible en: https://www.tandfonline.com/doi/abs/10.1080/0158037X.2022.2026315.
DAPOZO, Gladys y col. Capacitación en programación para incorporar el pensamiento computacional en las escuelas. Revista Iberoamericana de Tecnologı́a en Educación y Educación en Tecnologı́a, SciELO Argentina, n. 18, p. 113-121, 2016. Disponible en: https://dialnet.unirioja.es/servlet/articulo?codigo=5889939.
DAVOODIFARD, Mahshad. An Overview of Writing Process Research: Using Innovative Tasks and Techniques for a Better Understanding of L2 Writing Processes in Assessment Contexts. Studies in Applied Linguistics and TESOL, v. 21, n. 2, 2022. DOI: 10.52214/salt.v21i2.8759. Disponible en: https://journals.library.columbia.edu/index.php/SALT/article/view/8759.
DE BEAUGRANDE, Robert. Text production: Toward a science of composition. [S.l.]: Praeger, 1984. v. 11. DIDACTEXT, GRUPO DIDACTEXT Didáctica del Texto GRUPO. Modelo sociocognitivo, pragmalingüı́stico y didáctico para la producción de textos escritos. Didáctica. Lengua y Literatura, v. 15, p. 077-104, 2003. Disponible en: https://revistas.ucm.es/index.php/DIDA/article/download/DIDA0303110077A/19407.
DIETZ, Linus W y col. Teaching clean code. In: PROCEEDINGS of the 1st Workshop on Innovative Software Engineering Education. [S.l.: s.n.], 2018. Disponible en: http://ceur-ws.org/Vol-2066/isee2018paper06.pdf.
DIFABIO DE ANGLAT, Hilda. Hacia un inventario de escritura académica en el posgrado. Revista de orientación educacional, Universidad de Playa Ancha, n. 49, p. 37-53, 2012. Disponible en: https://dialnet.unirioja.es/descarga/articulo/4554495.pdf.
EGUILUZ, Andoni y col. Exploring the progression of early programmers in a set of computational thinking challenges via clickstream analysis. IEEE Transactions on Emerging Topics in Computing, IEEE, v. 8, n. 1, p. 256-261, 2017. DOI: 10.1109/TETC.2017.2768550. Disponible en: https://ieeexplore.ieee.org/abstract/document/8093668.
FIGUEIREDO, José y GARCÍA-PEÑALVO, Francisco José. Strategies to increase success in learning programming. In: IEEE. 2022 International Symposium on Computers in Education (SIIE). [S.l.: s.n.], 2022. p. 1-6. DOI: 10.1109/SIIE56031.2022.9982358. Disponible en: https://ieeexplore.ieee.org/abstract/document/9982358.
FINCHER, Sally. What are we doing when we teach programming? In: IEEE. FIE’99 Frontiers in Education. 29th Annual Frontiers in Education Conference. Designing the Future of Science and Engineering Education. Conference Proceedings (IEEE Cat. No. 99CH37011. [S.l.: s.n.], 1999. v. 1, 12a4-1. DOI: 10.1109/FIE.1999.839268. Disponible en: https://ieeexplore.ieee.org/abstract/document/839268.
FLOWER, Linda y HAYES, J. Textos en contexto. Buenos Aires, Argentina: Asociación Internacional de Lectura, 1996. Disponible en: http://www.a43d.com.uy/jenny/wp-content/uploads/2018/06/Flowers_y_Hayes.pdf.
FOWLER, Martin. Refactoring: improving the design of existing code. [S.l.]: Addison-Wesley Professional, 2018.
GARCÍA-BORREGO, Manuel y CÓRDOBA-CABÚS, Alba. La transformación en la motivación y las aspiraciones de los estudiantes de periodismo a lo largo de tres años de grado: un análisis de las variables explicativas. Vivat Academia. Revista de Comunicación, p. 23-41, 2021. DOI: 10.15178/va.2021.154.e1232. Disponible en: https://www.vivatacademia.net/index.php/vivat/article/view/1232.
GOLDSMITH, Rosalie; WILLEY, Keith y BOUD, David. Investigating invisible writing practices in the engineering curriculum using practice architectures. European Journal of Engineering Education, Taylor & Francis, v. 44, n. 1-2, p. 71-84, 2019. DOI: 10.1080/03043797.2017.1405241. Disponible en: https://www.tandfonline.com/doi/abs/10.1080/03043797.2017.1405241.
GONZÁLEZ, Martha Leticia Gaeta; GONZÁLEZ, Mercedes Zanotto y GONZÁLEZ-OCAMPO, Gabriela. Concepciones de escritura académica en estudiantes de medicina. IE Revista de Investigación Educativa de la REDIECH, Red de Investigadores Educativos Chihuahua AC, v. 11, p. 1-17, 2020. DOI: 10.33010/ie_rie_rediech.v11i0.855. Disponible en: https://www.redalyc.org/journal/5216/521662150034/521662150034.pdf.
GRIFFIN, Jean M. Designing intentional bugs for learning. In: PROCEEDINGS of the 1st UK & Ireland Computing Education Research Conference. [S.l.: s.n.], 2019. p. 1-7.
GROENEVELD, Wouter y col. Are Undergraduate Creative Coders Clean Coders? A Correlation Study. In: PROCEEDINGS of the 53rd ACM Technical Symposium on Computer Science Education V. 1. [S.l.: s.n.], 2022. p. 314-320. DOI: 10.1145/3478431.3499345.
GUPTA, Viral; KAPUR, Parmod Kumar y KUMAR, Deepak. Modelling and measuring code smells in enterprise applications using TISM and two-way assessment. International Journal of System Assurance Engineering and Management, Springer, v. 7, n. 3, p. 332-340, 2016. DOI: 10.1007/s13198-016-0460-0. Disponible en: https://link.springer.com/article/10.1007/s13198-016-0460-0.
HAYES, John R. y FLOWER, Linda S. Flower. Identifying the organization of writing processes. [S.l.]: Lawrence Erlbaum Assosiates, 1980.
IQBAL MALIK, Sohail y col. A web-based model to enhance algorithmic thinking for novice programmers. E-Learning and Digital Media, SAGE Publications Sage UK: London, England, v. 18, n. 6, p. 616-633, 2021. DOI: 10.1177/204275302110269. Disponible en: https://journals.sagepub.com/doi/full/10.1177/20427530211026988.
KILNER, Kerry; COLLIE, Natalie y CLEMENT, Jennifer. Using innovative teaching practices to inspire critically engaged reading and writing in a neoliberal university environment. Higher Education Research & Development, Taylor & Francis, v. 38, n. 1, p. 110-123, 2019. DOI: 10.1080/07294360.2018.1537258. Disponible en: https://www.tandfonline.com/doi/abs/10.1080/07294360.2018.1537258.
KYFONIDIS, Charalampos; MOUMOUTZIS, Nektarios y CHRISTODOULAKIS, Stavros. Block-C: A block-based programming teaching tool to facilitate introductory C programming courses. In: IEEE. 2017 IEEE Global Engineering Education Conference (EDUCON). [S.l.: s.n.], 2017. p. 570-579. DOI: 10.1109/EDUCON.2017.7942903. Disponible en: https://ieeexplore.ieee.org/abstract/document/7942903.
LACERDA, Guilherme y col. Code smells and refactoring: A tertiary systematic review of challenges and observations. Journal of Systems and Software, Elsevier, v. 167, pág. 110610, 2020. DOI: 10.1016/j.jss.2020.110610. Disponible en: https:
//www.sciencedirect.com/science/article/pii/S0164121220300881/pdfft?casa_token=KJpj0zf7uFgAAAAA: H6BXM-kDoEqT_GqUagfhDHRKZnUx9uA0xewQqU50T7Vgwy9PX3cilR5jHA5a_05-
noRQRTvufCk&md5=f259cb697bd1c02c96ae39cd7036fb65&pid=1-s2.0-S0164121220300881-main.pdf.
LINDGREN, Chris Aaron. Writing With Data: A Study of Coding on a Data-Journalism Team. Written Communication, SAGE Publications Sage CA: Los Angeles, CA, v. 38, n. 1, p. 114-162, 2021. DOI: 10.1177/0741088320968061. Disponible en: https://journals.sagepub.com/doi/10.1177/0741088320968061.
LIU, Hui; JIN, Jiahao y col. Deep learning based code smell detection. IEEE transactions on Software Engineering, IEEE, v. 47, n. 9, p. 1811-1837, 2019. DOI: 10.1109/TSE.2019.2936376. Disponible en: https://ieeexplore.ieee.org/abstract/document/8807230.
LIU, Xiaohua y READ, John. General skill needs and challenges in university academic reading: Voices from undergraduates and language teachers. Journal of College Reading and Learning, Taylor & Francis, v. 50, n. 2, p. 70-93, 2020. DOI: 10.1080/10790195.2020.1734885. Disponible en: https://www.tandfonline.com/doi/abs/10.1080/10790195.2020.1734885.
LONKA, Kirsti y col. How to measure PhD students’ conceptions of academic writing–and are they related to well-being? Journal of Writing Research, 2014. DOI: 10.17239/jowr-2014.05.03.1. Disponible en: http://www.jowr.org/articles/vol5_3/JoWR_2014_vol5_nr3_Lonka_et_al.pdf.
MALIK, Sohail Iqbal y COLDWELL-NEILSON, Jo. A model for teaching an introductory programming course using ADRI. Education and Information Technologies, Springer, v. 22, n. 3, p. 1089-1120, 2017. DOI: 10.1007/s10639-016-9474-0. Disponible en: https://link.springer.com/article/10.1007/s10639-016-9474-0.
MIRAS, Mariana; SOLÉ, Isabel y CASTELLS, Nuria. Creencias sobre lectura y escritura, producción de sı́ntesis escritas y resultados de aprendizaje. Revista mexicana de investigación educativa, Consejo Mexicano de Investigación Educativa AC, v. 18, n. 57, p. 437-459, 2013. Disponible en: https://www.scielo.org.mx/pdf/rmie/v18n57/v18n57a6.pdf.
MURPHY, Ellen; CRICK, Tom y DAVENPORT, James H. An analysis of introductory university programming courses in the UK. University of Bath, 2016. Disponible en: https://purehost.bath.ac.uk/ws/portalfiles/portal/147312704.
NAVARRO, Federico y col. Panorama histórico y contrastivo de los estudios sobre lectura y escritura en educación superior publicados en América Latina. Revista signos, SciELO Chile, v. 49, p. 78-99, 2016. DOI: 10.4067/S0718-09342016000400006. Disponible en: https://www.scielo.cl/pdf/signos/v49s1/art06.pdf.
NYSTRAND, Martin y col. Rhetoric’s “audience” and linguistics’“speech community”: Implications for understanding writing, reading, and text. What writers know: The language, process, and structure of written discourse, Academic Press New York, p. 1-28, 1982.
OORT, Bart van y col. The Prevalence of Code Smells in Machine Learning projects. In: IEEE. 2021 IEEE/ACM 1st Workshop on AI Engineering-Software Engineering for AI (WAIN). [S.l.: s.n.], 2021. p. 1-8. DOI: 10.1109/WAIN52551.2021.00011. Disponible en: https://ieeexplore.ieee.org/abstract/document/9474395/.
PÉREZ, D; HERNÁNDEZ, Carmen Requena y GONZÁLEZ, Marta Zubiaur. Evolución de motivaciones, actitudes y hábitos de los estudiantes de la Facultad de Ciencias de la Actividad Fı́sica y del Deporte de la Universidad de León. European Journal of Human Movement, Asociación Española de Ciencias del Deporte, n. 14, p. 65-79, 2005. Disponible en: https://dialnet.unirioja.es/descarga/articulo/2279075.pdf.
PROKIĆ, Simona y col. Clean Code and Design Educational Tool. In: IEEE. 2021 44th International Convention on Information, Communication and Electronic Technology (MIPRO). [S.l.: s.n.], 2021. p. 1601-1606. DOI: 10.23919/MIPRO52101.2021.9597196. Disponible en: https://ieeexplore.ieee.org/abstract/document/9597196.
ROALD, Gunhild Marie y col. Learning from contrasts: first-year students writing themselves into academic literacy. Journal of Further and Higher Education, Taylor & Francis, v. 45, n. 6, p. 758-770, 2021. DOI: 10.1080/0309877X.2020.1813264. Disponible en: https://www.tandfonline.com/doi/full/10.1080/0309877X.2020.1813264.
RODRÍGUEZ HERNÁNDEZ, Blanca Araceli y GARCÍA VALERO, Laura Beatriz. Escritura de textos académicos: dificultades experimentadas por escritores noveles y sugerencias de apoyo. Instituto de Investigaciones en Educación de la Universidad Veracruzana, 2015. DOI: 10.25009/cpue.v0i20.1332. Disponible en: https://cpue.uv.mx/index.php/cpue/article/view/1332/2450.
SANTOS, André L. Javardise: a structured code editor for programming pedagogy in Java. In: CONFERENCE Companion of the 4th International Conference on Art, Science, and Engineering of Programming. [S.l.: s.n.], 2020. p. 120-125. DOI: 10.1145/3397537.3397561. Disponible en: https://dl.acm.org/doi/abs/10.1145/3397537.3397561.
SELWYN, Rebecca y RENAUD-ASSEMAT, Irene. Developing technical report writing skills in first and second year engineering students: a case study using self-reflection. Higher Education Pedagogies, Taylor & Francis, v. 5, n. 1, p. 19-29, 2020. DOI: 10.1080/23752696.2019.1710550. Disponible en: https://www.tandfonline.com/doi/full/10.1080/23752696.2019.1710550.
SOMMERVILLE, Ian. Engineering software products. [S.l.]: Pearson London, 2020.
TORRENT MALUJE, Catalina Andrea. Programación computacional en escuelas: una mirada de inclusión y género a una iniciativa extracurricular del Ministerio de Educación de Chile. [S.l.]: Universidad de Chile, 2019. Disponible en: https://repositorio.uchile.cl/handle/2250/170511.
TURKBEN, Tuncay. The Relationship between Fifth Grade Student’s Writing Anxiety and Blocking with Their Written Expression Skills. International Online Journal of Education and Teaching, ERIC, v. 8, n. 2, p. 998-1021, 2021. Disponible en: https://hdl.handle.net/20.500.12451/8378.
ULU, Hacer. Investigation of Fourth Grade Primary School Students’ Creative Writing and Story Elements in Narrative Text Writing Skills. International Journal of Progressive Education, ERIC, v. 15, n. 5, p. 273-287, 2019. DOI: 10.29329/ijpe.2019.212.18. Disponible en: https://ijpe.inased.org/makale/1126.
VALDÉS-LEÓN, Gabriel. Análisis de errores y variables sociolingüísticas: cómo escriben los estudiantes de primer año de universidad. Onomázein, Taylor & Francis, v. 58, 2022. DOI: 10.7764/onomazein.58.12. Disponible en: http://revistacienciapolitica.uc.cl/index.php/onom/article/view/58475.
VINE-JARA, Ana E. La escritura académica: percepciones de estudiantes de Ciencias Humanas y Ciencias de la Ingenierı́a de una universidad chilena. Íkala, Revista de Lenguaje y Cultura, Escuela de Idiomas, Universidad de Antioquia, v. 25, n. 2, p. 475-491, 2020. Disponible en: https://www.redalyc.org/journal/2550/255066610011/255066610011.pdf.
VOOGT, Joke y col. Computational thinking in compulsory education: Towards an agenda for research and practice. Education and Information Technologies, Springer, v. 20, p. 715-728, 2015. DOI: 10.1007/s10639-015-9412-6. Disponible en: https://link.springer.com/article/10.1007/s10639-015-9412-6.
WALTON, Gabriel. Writing skills development in an engineering geology course through practice and feedback on report submissions using a rubric. Journal of Geoscience Education, Taylor & Francis, v. 68, n. 1, p. 33-48, 2020. DOI: 10.1080/10899995.2019.1625997. Disponible en: https://www.tandfonline.com/doi/abs/10.1080/10899995.2019.1625997.
WEDYAN, Fadi y ABUFAKHER, Somia. Impact of design patterns on software quality: a systematic literature review. IET Software, Wiley Online Library, v. 14, n. 1, p. 1-17, 2020. DOI: 10.1049/iet-sen.2018.5446. Disponible en: https://ietresearch.onlinelibrary.wiley.com/doi/full/10.1049/iet-sen.2018.5446.
WEINTROP, David. Block-based programming in computer science education. Communications of the ACM, ACM New York, NY, USA, v. 62, n. 8, p. 22-25, 2019. DOI: 10.1145/3341221.
WING, Jeannette M. Computational thinking and thinking about computing. Philosophical Transactions of the Royal Society A: Mathematical, Physical and Engineering Sciences, The Royal Society London, v. 366, n. 1881, p. 3717-3725, 2008. DOI: 10.1098/rsta.2008.0118. Disponible en: https://royalsocietypublishing.org/doi/abs/10.1098/rsta.2008.0118.
XAVIER, Marlon y MENESES, Julio. Persistence and time challenges in an open online university: a case study of the experiences of first-year learners. International Journal of Educational Technology in Higher Education, SpringerOpen, v. 19, n. 1, p. 1-17, 2022. DOI: 10.1186/s41239-022-00338-6. Disponible en: https://educationaltechnologyjournal.springeropen.com/articles/10.1186/s41239-022-00338-6.
Downloads
Published
How to Cite
Issue
Section
License
Copyright (c) 2023 Cristian Olivares-Rodríguez, Gabriel Valdés-León, Martha Vidal-Sepúlveda, Romina Oyarzún-Yañez
This work is licensed under a Creative Commons Attribution 4.0 International License.
This is an open access article that allows unrestricted use, distribution and reproduction in any medium as long as the original article is properly cited.
![Licença Creative Commons](https://periodicos.ufmg.br/index.php/textolivre/management/settings/website//index.php/textolivre/manager/setup/<a%20rel="license"%20href="http:/creativecommons.org/licenses/by/4.0/"><img%20alt="Licença%20Creative%20Commons"%20style="border-width:0"%20src="https:/i.creativecommons.org/l/by/4.0/88x31.png"%20/></a><br%20/>Este%20obra%20está%20licenciado%20com%20uma%20Licença%20<a%20rel="license"%20href="http:/creativecommons.org/licenses/by/4.0/">Creative%20Commons%20Atribuição%204.0%20Internacional</a>.)
