12
Is there a "markup language" to describe a debugging session?
(sh.itjust.works)
A community for discussion amongst professional software developers.
Posts should be relevant to those well into their careers.
For those looking to break into the industry, are hustling for their first job, or have just started their career and are looking for advice, check out:
I write my notes in org-mode. It's supported in many editors in a basic form, letting you add code snippets etc in an unobtrusive way. Using a well thought out format helps you in the long run.
I use this in Emacs, through which it lets me refer to emails, execute code snippets, attach related files, fetch content on/from remote servers, send off the debug session as an html email, ... Support will depend on your editor but even as raw text it works.
I don't use something specific to make non-code repeatable as you suggest here, but you could embed a test language in an org code block.
The syntax is straight-forward and exports to multiple external formats exist (eg: html).