My most recent personal project has been to complete a user help guide using DITA principles.
I created my guide using a free trial of ClickHelp, which I chose since it is browser-based, requiring no additional software or downloads.
This platform is a little bit basic, but I thought it was good for my purposes since I wanted to be able to practice user guide documentation while demonstrating my ability to write clearly and concisely.
I created documentation for InTouch Language Inc, the phone English company I work for part-time. Their existing training for teachers exists in discrete documents scattered across emails, videos, and various cloud drives. Not to mention, it’s not even written by native English speakers.
My final version is, in fact, a draft, because I have created this independent of a team or supervisor. In a real job setting, I understand that creating and maintaining user guides would be an iterative process.
However, working on this project made me happy. I would love to do more work like this in the future, especially with different platforms.
The guide now exists in Word doc format and HTML. Here are some screenshots from the HTML version, which I’ve hosted on Github.