Framework para la documentación automática de procesos de negocio mediante un modelo transaccional en JavaScript
Framework para la documentación automática de procesos de negocio mediante un modelo transaccional en JavaScript
PDF

Palabras clave

Documentación Automática
Proceso de Negocio
Modelo Transaccional
Patrón SAGA
JavaScript
Rutina
Mantenimiento de Software
Prueba de Aceptación

Categorías

Cómo citar

Framework para la documentación automática de procesos de negocio mediante un modelo transaccional en JavaScript. (2026). Sciencevolution, 5(3), 33-48. https://doi.org/10.61325/pj992973

Resumen

La documentación respecto a la creación de sistemas de software puede quedar desactualizada frente a la implementación, dificultando la comprensión y el mantenimiento de los procesos de negocio. En esta investigación se desarrolló un framework para JavaScript con base en un modelo transaccional utilizado como fuente para elaborar documentación estructurada en HTML. El objetivo fue diseñar, implementar y evaluar su capacidad para generar documentación automática utilizando transacciones y rutinas. La investigación aplicada estuvo orientada al desarrollo tecnológico, con alcance descriptivo-evaluativo y empleó un enfoque cuantitativo, con diseño no experimental y estudio de caso único. Se evaluaron 34 escenarios de aceptación, integrados por 236 pasos e implementados mediante Cucumber, correspondientes al backend de una plataforma financiera. Los datos se recolectaron a través de pruebas de aceptación y comparación estructurada entre las definiciones del código y el HTML generado. Los 34 escenarios y 236 pasos se ejecutaron sin fallos en 4.75 segundos. Asimismo, se comprobó la correspondencia de 12 transacciones, 23 usos de rutinas, sus secuencias e indicadores de reverso y una rutina reutilizada, sin discrepancias. Se concluyó que el framework fue viable para el caso estudiado y permitió vincular de forma directa y reproducible la documentación con la implementación.

PDF

Referencias

Aghajani, E., Nagy, C., Linares-Vásquez, M., Moreno, L., Bavota, G., Lanza, M., & Shepherd, D. C. (2020). Software documentation: The practitioners’ perspective. In Proceedings of the ACM/IEEE 42nd International Conference on Software Engineering (pp. 590–601). Association for Computing Machinery. https://doi.org/10.1145/3377811.3380405

Banias, O., Florea, D., Gyalai, R., & Curiac, D.-I. (2021). Automated specification-based testing of REST APIs. Sensors, 21(16), 5375. https://doi.org/10.3390/s21165375

Ciurumelea, A., Alexandru, C. V., Gall, H. C., & Proksch, S. (2023). Completing function documentation comments using structural information. Empirical Software Engineering, 28(4), Article 86. https://doi.org/10.1007/s10664-022-10284-6

Daraghmi, E., Zhang, C.-P., & Yuan, S.-M. (2022). Enhancing saga pattern for distributed transactions within a microservices architecture. Applied Sciences, 12(12), 6242. https://doi.org/10.3390/app12126242

Dvivedi, S. S., Vijay, V., Pujari, S. L. R., Lodh, S., & Kumar, D. (2023). A comparative analysis of large language models for code documentation generation. arXiv. https://doi.org/10.48550/arXiv.2312.10349

Fan, A., Gokkaya, B., Harman, M., Lyubarskiy, M., Sengupta, S., Yoo, S., & Zhang, J. M. (2023). Large language models for software engineering: Survey and open problems. arXiv. https://doi.org/10.48550/arXiv.2310.03533

Fantino, G., Vetro’, A., Torchiano, M., & Cappelluti, F. (2026). Beyond syntax: Enhancing automated documentation with data differences. Automated Software Engineering, 33, Article 77. https://doi.org/10.1007/s10515-026-00623-y

Farooq, M. S., Omer, U., Ramzan, A., Rasheed, M. A., & Atal, Z. (2023). Behavior driven development: A systematic literature review. IEEE Access, 11, 88008–88024. https://doi.org/10.1109/ACCESS.2023.3302356

Farshidi, S., Beer Kwantes, I., & Jansen, S. (2024). Business process modeling language selection for research modelers. Software and Systems Modeling, 23, 137–162. https://doi.org/10.1007/s10270-023-01110-8

Gao, C., Hu, X., Gao, S., Xia, X., & Jin, Z. (2025). The current challenges of software engineering in the era of large language models. ACM Transactions on Software Engineering and Methodology, 34(5), Article 127, 1–30. https://doi.org/10.1145/3712005

Ghale, D. P., & Dabbagh, M. (2025). Automated code comments generation using large language models: Empirical evaluation of T5 and BART. IEEE Access, 13, 141420–141433. https://doi.org/10.1109/ACCESS.2025.3597601

Haapakoski, J. (2023). Implementing asynchronous sagas in a microservice architecture [Master’s thesis, Tampere University].

Hassan, H. B., Sarhan, Q. I., & Beszédes, Á. (2024). Evaluating Python static code analysis tools using FAIR principles. IEEE Access, 12, 173647–173659. https://doi.org/10.1109/ACCESS.2024.3503493

Hovhannisyan, A., Fan, Y., Rodríguez-Pérez, G., & Kula, R. G. (2024). Linking code and documentation churn: Preliminary analysis. In 2024 IEEE 35th International Symposium on Software Reliability Engineering Workshops (ISSREW) (pp. 107–108). IEEE. https://doi.org/10.1109/ISSREW63542.2024.00058

Karlsson, S., Čaušević, A., & Sundmark, D. (2020). QuickREST: Property-based test generation of OpenAPI-described RESTful APIs. In 2020 IEEE 13th International Conference on Software Testing, Validation and Verification (ICST) (pp. 131–141). IEEE. https://doi.org/10.1109/ICST46399.2020.00023

Khan, J. Y., & Uddin, G. (2022). Automatic code documentation generation using GPT-3. In Proceedings of the 37th IEEE/ACM International Conference on Automated Software Engineering (pp. 1–6). Association for Computing Machinery. https://doi.org/10.1145/3551349.3559548

Kiecker, T., Sparka, J. A., Reuter, M., Ziegler, A., & Grunske, L. (2026). CASCADE: Detecting inconsistencies between code and documentation with automatic test generation. Proceedings of the ACM on Software Engineering, 3(FSE), Article FSE168, 3816–3838. https://doi.org/10.1145/3808175

Lee, W.-T., Song, P.-Y., & Tsai, M.-K. (2025). A data-consistent microservices architecture library using saga design pattern and backup mechanism. Journal of Information Science and Engineering, 41(1), 121–136. https://doi.org/10.6688/JISE.202501_41(1).0007

Padoan, F., Santos, R. de S., & Medeiros, R. P. (2024). Charting a path to efficient onboarding: The role of software visualization. In Proceedings of the 2024 IEEE/ACM 17th International Conference on Cooperative and Human Aspects of Software Engineering (CHASE ’24) (pp. 133–143). Association for Computing Machinery. https://doi.org/10.1145/3641822.3641873

Qiao, M., Li, L., Hou, B., Shang, Z., & Luo, Z. (2025). Research on automated software documentation generation based on modular design. In Proceedings of the 2025 6th International Conference on Computer Science and Management Technology (pp. 1197–1202). Association for Computing Machinery. https://doi.org/10.1145/3795154.3795348

Rai, S., Belwal, R. C., & Gupta, A. (2022). A review on source code documentation. ACM Transactions on Intelligent Systems and Technology, 13(5), 1–44. https://doi.org/10.1145/3519312

Santos, S., Pimentel, T., Rocha, F. G., & Soares, M. S. (2024). Using behavior-driven development (BDD) for non-functional requirements. Software, 3(3), 271–283. https://doi.org/10.3390/software3030014

Tan, W. S., Wagner, M., & Treude, C. (2024). Detecting outdated code element references in software repository documentation. Empirical Software Engineering, 29(1), Article 5. https://doi.org/10.1007/s10664-023-10397-6

Velepucha, V., & Flores, P. (2023). A survey on microservices architecture: Principles, patterns and migration challenges. IEEE Access, 11, 88339–88358. https://doi.org/10.1109/ACCESS.2023.3305687

Wu, X. (2024). Diseño e implementación de una plataforma de gestión financiera personal [Trabajo de Fin de Grado, Universidad Politécnica de Madrid]. https://oa.upm.es/82475/

Yang, D., Simoulin, A., Qian, X., Liu, X., Cao, Y., Teng, Z., & Yang, G. (2025). DocAgent: A multi-agent system for automated code documentation generation. In Proceedings of the 63rd Annual Meeting of the Association for Computational Linguistics (Volume 3: System Demonstrations) (pp. 460–471). Association for Computational Linguistics. https://doi.org/10.18653/v1/2025.acl-demo.44

Yıldız, A., & Demirörs, O. (2025). MicroArc: Event driven analysis and design method for microservices. Procedia Computer Science, 263, 583–590. https://doi.org/10.1016/j.procs.2025.07.070

Creative Commons License

Esta obra está bajo una licencia internacional Creative Commons Atribución-NoComercial-SinDerivadas 4.0.

Derechos de autor 2026 Erick Medel Galindo, Gabriel Sánchez Bautista