The following examples of technical writing and tutorial documentation are exclusively conceived and written by myself.
As part of my role in Communications and UX Design at Community Information Support Services, I took on the task of writing User Support Help Topics documentation for their flagship product, My Community Directory. More than just a directory, they have a deep set of tools for discovery, as well as sharing and analysis for the service providers. As many of the features are not immediately obvious they richly deserved to have their stories told.
For QUT’s MOOC program I applied my previous knowledge of WCAG 2.0 accessibility requirements to this course content as we developed it over several months. From this I wrote a MOOC Accessibility guide applicable to the academics, learning designers and production team which highlighted the most common areas of accessibility requirements we needed to meet and the most appropriate actions to take.
Also for QUT’s MOOC program, we decided to use a newly untested feature on our LMS platform which connected their proprietary Event registration & Discussion Forum systems with a live streaming Google Hangout on Air event. When you couple the factors of new with unrelated-systems – bugs, gotchas and other issues are inevitable. This was eventually going live to 12,000+ students around the world on numerous occasions, so having hangups or delays was not an option. I painstakingly user-tested with our production team and documented every step for the professors and tutors that would be conducting these in my MOOC EdCast Event Hangout on Air Guide.
On the Arts-POP project, having hundreds of documents from multiple authors could have easily snow-balled into a quagmire of disparate styles and post-production. I designed a style guide to ensure as much consistency and as little post-production as possible as Word documents made their way to both HTML and PDF formats.
On QUT’s Robotics MOOC project I was brought on board to migrate the production from using Microsoft Powerpoint to Apple Keynote and wrote up this quick guide & tips for other Learning Designers new to the process.
Admin User Guide for a private Qld Gov’t social network site.
Member User Guide for a private Qld Gov’t social network site.