Quick tip: document your technical procedures with video

Posted: (EET/GMT+2)

 

Many developers are not very fond of writing documentation, but even so, most projects need (or at least would benefit) from documentation. When the iron is still hot and you've just completed the code, it's human to think that you will remember every detail perfectly clear. But as time passes by, things start to be forgotten. Also, people in the project might change, so somebody completely fresh to the project might become the maintenance lead. These are just two reasons you need some documentation.

Writing things down with Word is nice, but time-consuming and actually, quite hard work. Oftentimes, you need specific instructions on how to do certain things, and for this, screen videos are a good choice. Not that you would have everything in video, but you could for example document internal technical implementation details with screencast videos, and possible voice-over commentary.

There are several good products to record video on Windows; from the commercial side, Techsmith's Camtasia Studio comes into mind.