Made-up practice example
An example project write-up
See how to explain what you did and how you checked it.
Finding the correct club guide — made-up example
This example uses the sample file-recovery project. It was written for this site and is not a student’s work.
See the file comparisonWhat I did
I compared the three practice files, saved the matching copy, and checked it.
Progress
Finished
The problem
Three copies of the guide had different information. The correct copy needed all eight lines listed in the instructions.
Who it was for
The organizer in the made-up Lantern Club activity.
What I made or fixed
I chose copies/guide-backup.txt because it had all eight required lines. I saved an unchanged copy as worked-example/handoff/lantern-guide.txt and wrote a note explaining the choice.
My checks and results
Required text — I expected all eight lines. All eight were in guide-backup.txt.
Saved copy — I expected it to match the original. Its contents matched exactly.
Original files — I expected all three to stay unchanged. The Python checker confirmed that all three matched their recorded checksums.
Files and links
- comparison.csv — compares the three files.
- lantern-guide.txt — the saved copy I checked.
- test-results.csv — the checks and results.
- handoff-note.md — explains the choice and checks.
What I improved
My first note only named the file. I added the comparison and explained where the copy came from. I checked again that writing the note had not changed the file.
What still needs work
This example compares existing copies. It does not recover a deleted file or test a real backup service.
Next step
Ask another reader to follow the note, choose the same file, and repeat the checks.
Help and sources
Titan Foundry’s made-up practice files, a text editor, and the supplied Python checker. This is an example, not a student’s project.