Dear Diary: creating enhanced web development documentation artifacts
External reference persons Juan Pablo Saenz Moreno
Research Groups DAUIN - GR-10 - Intelligent and Interactive Systems - e-LITE
Thesis type EXPERIMENTAL, RESEARCH
Description In the context of programming courses, novice programmers do not usually rely on their documentation to keep track of the successes and errors they find during their development process: how they achieved the working versions of the project or overcame the various errors, the sources consulted, and the pieces of advice to remember or give to someone else. Consequently, critical aspects such as the background knowledge, the rationale for the solution, or step-by-step instructions for arriving at similar or related solutions are always left out from the documentation artifacts. As a result, these artifacts are not helpful to the novices themselves or other developers to overcome issues or guide the development of new projects.
Against this backdrop, this thesis proposes designing, developing, and assessing a tool to support non-expert programmers in creating context-aware documentation artifacts. On the one hand, the platform should automatically gather relevant technical information directly from the IDE; and, on the other hand, enable programmers to enrich such technical knowledge with their insights and comments. The tool can be an extension for an IDE such as Visual Studio Code.
Regarding the information that can be automatically gathered by the tool, the following items are foreseen:
1. Information about the development and execution environment (the development and execution dependencies).
2. A snapshot of the development project in which they are working (e.g., code and files structure).
3. A log of all the command-line operations executed since that last snapshot, along with their corresponding outputs.
If satisfying, the thesis code will be released as an open source project.
Deadline 22/03/2022 PROPONI LA TUA CANDIDATURA