Event box
Research Software Engineering: Documentation for Sustainability
This is the fourth in a series of workshops designed to teach best practices for research software engineering to ensure reproducibility and sustainability of code developed at CMU.
Attendance at every workshop session is not necessary.
This workshop’s goal is to equip participants with the essential skills and tools to document their research software effectively and ensure that their analysis is fully reproducible by others (and their future selves).
Specifically participants will:
- Design a comprehensive README that serves as the single source of truth for software setup including config.yaml, contributing.md, and requirements.txt
Implement simple practices to integrate documentation and coding standards (FAIR) into their workflow - Understand and utilize environment encapsulation tools (e.g., Docker) to manage dependencies reliably
- Differentiate between user guides, tutorials, and interactive documentation, and know when to use each
No coding experience is needed. If participants have a project that they are working on, we can use that throughout the workshop. Otherwise, example projects will be provided for participants to practice these skills.
Other events in this series:
Maintenance Practices for Sustainable, Open-source Code - October 6, 2026: link
- Date:
- Tuesday, September 29, 2026
- Time:
- 10:00am - 11:00am
- Time Zone:
- Eastern Time - US & Canada (change)
- Location:
- Sorrells Library, Den
- Campus:
- Sorrells Library
- Audience:
- Alumni Faculty Pittsburgh community Staff Students
- Categories:
- Open Science Working With Data and Code
In-Person Workshop Information:
Directions for getting to the Den of Sorrells Library:
Sorrells Library is on the 4th Floor of Wean Hall, shown on the map here. If you enter in the front of Wean Hall, take the elevator down one floor. When you exit the elevator, the library will be on your left. The Den is in the back of the library.
Automated notetaking tools and recordings not initiated by the instructor are generally not permitted in workshops. However, participants may request permission to use approved tools, such as Zoom AI Companion, for accommodation purposes. To ensure appropriate arrangements, please submit these requests to instructors at least 24 hours prior to the workshop.
Workshops and events for Carnegie Mellon University Libraries are open to all, regardless of race, color, national origin, sex, disability, age, sexual orientation, gender identity, religion, creed, ancestry, belief, veteran status or genetic information. All participants are required to follow the Code of Conduct.
If you require accessibility accommodations, please contact the event organizer.
