The Art of Documentation

Tue, 30 Aug 2022 00:00:00 +0000

Documentation is one of the most valuable artifacts of any technology project or platform. It provides context to new joiners, avoids duplicating responses via Slack/Teams, and facilitates asynchronous communication, but it also requires constant care and feeding.

Confluence is where documentation goes to die
– Unknown

Most of the large enterprises that I’ve worked for have a large corpus of documentation in a wiki of some sort. Most of it is dangerously out-of-date, incomplete, duplicated, and fragmented across different pages or spaces. Documentation of this kind causes countless wasted hours and frustration on the part of the reader. There’s nothing worse than spending days working through a documented process only to discover that you’re following an outdated copy because only wiki admins can delete pages.

Good Support

Wed, 02 Nov 2016 00:00:00 +0000

I recently had an unexpectedly great support experience from a company that one does not usually associate with excellent customer support: Microsoft.

I had been running Windows 10 as a VirtualBox VM on my Linux laptop for quite some time. I needed Windows for a few things like my accounting software (Quickbooks) and remote access to the office but the setup wasn’t working as cleanly as I’d like, particularly around support for external devices like my Garmin Forerunner GPS watch so I decided to switch to a dual boot.

Support on Craig Pardey

The Art of Documentation

Good Support