4 ms·
Hi, I'm the author. I write a lot of technical software docs for a living so I'm no stranger to writing, but this was my first attempt at such an informal write
by Slortibort 5y ago
Hi, I'm the author. I write a lot of technical software docs for a living so I'm no stranger to writing, but this was my first attempt at such an informal writeup.
I started trying to fix it on a Friday evening and gave up after I couldn't get the "abort -> No Operation" thing. When I came back a couple of days later, I realised how I was going to proceed, but wanted to write it up. I made sure the thread I was pulling made sense (and thus I was confident I'd get to the end of this), stopped, and wrote the writeup to that point retrospectively. I also went back and recreated some of the screenshots.
From then on I played with the software for a bit until I "hit a breakthrough", stopped, and wrote the story and took some screenshots, then worked on the software until the next "breakthrough". I wanted this doc to record offsets and methodology so I made sure to include that wherever I could. I also used the document as a "rubber-duck debugging" aide, writing it for someone unfamiliar to the project.
I then polished/edited it (rushedly, without too much care) the day after and put it up. You can see my shift in methodology a few times where I mess up the past and present tense and with how some bits have considerably more detail than others.
As this is my first, I don't know if I'd do it the same way again. I've got a HW hacking project on the go and while I've taken loads of pictures, I think I'll probably be writing that up fully retrospectively.
- akavel 5y agoThanks a lot for the reply!! FWIW, I didn't notice the change of tenses or other stuff at all, found the whole piece very engaging and interesting! (Though admittedly skimmed some details that I didn't care enough about :P) As for rubber-duck debugging, that's a benefit I didn't think of, thanks!