Skip to content

Teaching a new codebase #103

Open
Open
@joonas-fi

Description

@joonas-fi

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:

  • Directory view (show file tree which file we're in)
  • Code view (show which code line we're on, even variable contents?)
  • Can even show map of previous functions and upcoming functions, like table of contents for the timeline

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions