joonas-fi / joonas.fi

My personal blog
https://joonas.fi/
Apache License 2.0
3 stars 1 forks source link

Teaching a new codebase #103

Open joonas-fi opened 1 year ago

joonas-fi commented 1 year ago

Run program with the most important use cases, step through with a debugger automatically. Get a stack trace of the whole process. Exclude going into unimportant leaf nodes (maybe annotate things which should be kept in the walkthrough)

We could automatically make a video with panes:

This all could be generated automatically and kept updated as the software evolves. You would just need to annotate the use cases.

A killer idea for teaching new people about the codebase.

https://mobile.twitter.com/DavidKPiano/status/1573261151311470593