One of my most frequent pieces of advice to students preparing presentations, and also applies to documentation:
The thing that is most obvious to you is likely to be…
(1) the most import thing for your audience to hear and
(2) the thing you are most likely to forget to say.
Re this from @mcc:
https://mastodon.social/@mcc/111882248303112285
@inthehands @mcc This reminds me of the first piece of code I submitted after transferring to a new university. I confirmed I could use any language on the lab machines, and they had ruby (before rails)!
So I knew the TA wouldn’t know anything about it, I made a README with simple instructions. Run the command:
$ ./runme.rb
I flunked the assignment. The TA reported the following error:
bash: $: command not found
@josephholsten @mcc As a teacher, the TA’s reaction amuses me and enrages me in equal measure.
@inthehands @mcc It was shocking to someone who’d been using Unix for a decade at that point. But it was Oklahoma and plenty of folks were very Windows focused. We got it fixed eventually after a few emails.