Teaching Software Documentation through an Asynchronous Module: An Experience ReportGlobal
We present the development of an asynchronous online module for teaching software documentation in an introductory software design course. Drawing on literature from industry practices and computing education, we designed a lightweight, self-paced module that introduces students to the principles of effective documentation. A central feature of the module is our ACCEU framework, which defines five key dimensions of documentation quality: accuracy, clarity, completeness, ease of use, and up-to-dateness. These dimensions are grounded in a synthesis of prior research and serve as a practical guide for students documenting both code and software projects. We describe the pedagogical motivations behind our design, the structure and content of the module, and initial student feedback. Our experience suggests that the module was well received by our students and met our goals. We conclude with recommendations for instructors interested in adopting or adapting our described approach.
Fri 20 FebDisplayed time zone: Central Time (US & Canada) change
15:40 - 17:00 | |||
15:40 20mTalk | Teaching Software Documentation through an Asynchronous Module: An Experience ReportGlobal Papers | ||
16:00 20mTalk | A Framework to Detect, Classify, and Prioritise Student Quality DefectsGlobal Papers Shiman Cui The University of Auckland, Paul Denny The University of Auckland, Andrew Luxton-Reilly The University of Auckland | ||
16:20 20mTalk | Turning Insight into Action: Evaluating Targeted Interventions for a Software Engineering Course Informed by Student Reflections Papers Sandra Wiktor University of North Carolina at Charlotte, Mohsen Dorodchi University of North Carolina Charlotte | ||
16:40 20mTalk | Benchmarking AI Tools for Software Engineering Education: Insights into Design, Implementation, and Testing Papers Nimisha Roy Georgia Institute of Technology, Oleksandr Horielko Georgia Institute of Technology, Fisayo Omojokun Georgia Institute of Technology | ||