CMSE 495
Michigan State University Data Science Capstone.
Install Instruction Review
Agenda (80 Minutes)
- (5 minutes) Shout Outs
- (60 minutes) Install Instruction Reviews
- (15 minutes) Group meeting
Shout-Outs
Do we have any shout outs for this week? How are things going?
NEW Tripods
Hey class, we are going to try out new Tripods this round. Please see list below!!
Install Instruction Reviews
This is a team paring exercise. Your team will work with your tripod to review your projects install instructions. Split each of your teams into two groups of 2-3 people. Have your bigger group stay at your table to be the “Host Team” and the smaller group move to be the “Guest Team” at another table.
| Tripod V2 | Team A | Team B | Team C |
|---|---|---|---|
| 1 | CEPI | HFH_MT | HAP |
| 2 | Documenters | MSU_HC | HFH_RC |
| 3 | HFH_QC | HFH_PP | Grassroots |
| 4 | MSU_JO | MSU_WD | MSU_GR |
| 5 | TechSmith | TwoSix | QSIDE |
Once the mixed teams are formed, have the host team walk the guest team through the install instructions. If possible pair up in the newly formed teams and have members from the guest team try to install the software from scratch from either their personal laptop or a personal account such as the HPCC, jupyterhub or googlecolab.
If their are concerns about data security (i.e NDAs), either use unrestricted phantom data or you can have one of the guests share one of the host teams computer’s just for this activity. The reasoning here is that they would still be there and in control of the data and not sharing it with you.
Have the group members from the host team hold back and only give advice and support if there is a problem. The idea is to streamline the process so that the documentation and instructions are sufficient for someone outside of the host team to be able to install, test and use the software without needing to have help. As a group take lots of notes and review the unit tests and documentation to the host team some constructive feedback. If you are a member of the host team, use this as an opportunity to fix problems as they are discovered.
As a group, prepare a report for the instructor and the development team. This report should provide the following:
- Clearly label which teams code is being evaluated.
- List of the evaluation group members with an indication about which capstone team they are on and their roles in the meeting.
- Was someone outside the development team able to install the software and get the unit tests working? If not, what was the problem?
- Briefly describe the completeness of the install instructions. Was the review team able to identify any missing steps.
- Is there anything that needed to be added to the documentation to make the project easier to install and test?
- Was there anything you could add to the project to help make the project better?
This is a group effort, email the report to the instructors and cc the other members that are at the table (both host and guest teams).
Note, the above instructions may not work for all projects. Some projects may require a demonstration instead of an actual install due to software limitations. Do the best you can. Make sure not to violate any NDA
Group meeting
Conduct a group meeting for the remainder of the class. Check your project milestones, progress and make plans to practice and finish your presentation by next week.
Written by Dr. Dirk Colbry, Michigan State University
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.