{"id":4331,"date":"2015-08-02T23:50:14","date_gmt":"2015-08-02T13:50:14","guid":{"rendered":"http:\/\/www.jasonshanks.com\/?page_id=4331"},"modified":"2018-03-08T13:28:09","modified_gmt":"2018-03-08T03:28:09","slug":"technical-writing","status":"publish","type":"page","link":"https:\/\/www.jasonshanks.com\/portfolio\/technical-writing\/","title":{"rendered":"technical writing & documentation"},"content":{"rendered":"

Examples<\/h3>\n

The following examples of technical writing and tutorial documentation are exclusively conceived and written by myself.<\/p>\n

\n
\"Qld<\/a>
DoH Web design guide<\/figcaption><\/figure>\n

I was contracted by the Queensland Dept of Health to finalise their UX research and implement their IA redevelopment for the Human Resources intranet. My key outputs included designing the UI elements, coding a HTML5\/CSS3\/Javascript framework and applying it to the majority of existing. This is best seen contextually in the Web design guide<\/a> I wrote for ongoing publishers and content writers. I trained over 30 publishers across all of Corporate Services Division including my immediate team in carrying this forward through my Intranet template web design training<\/a> workshops.\n<\/div>\n

\n
\"My<\/a>
MCD Support Guides<\/figcaption><\/figure><\/p>\n

As part of my role in Communications and UX Design at Community Information Support Services, I took\u00a0on\u00a0the task of writing User Support Help Topics documentation<\/strong><\/a> for their flagship product, My Community Directory<\/a>. More than just a directory, they have a deep set of tools for discovery, as well as sharing and analysis for\u00a0the service providers. As many\u00a0of the features are not immediately obvious they\u00a0richly deserved to have their stories told.<\/p>\n<\/div>\n

\n
\"cover<\/a>
MOOC Accessibility Guide<\/figcaption><\/figure>\n

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<\/a> 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.<\/p>\n<\/div>\n

\n
\"cover<\/a>
MOOC Google Hangout Guide<\/figcaption><\/figure>\n

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<\/em> with unrelated-systems \u2013\u00a0<\/em>bugs, gotchas and other issues are inevitable. This was\u00a0eventually\u00a0going\u00a0live 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\u00a0MOOC EdCast Event Hangout on Air Guide<\/a>.<\/p>\n<\/div>\n

\n
\"On<\/a>
Web Writing Style Guide<\/figcaption><\/figure>\n

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<\/a> to ensure as much consistency and as little post-production as possible as Word documents made their way to both HTML and PDF formats.<\/p>\n<\/div>\n

\n
\"I<\/a>
Keynoting Tips<\/figcaption><\/figure>\n

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<\/a> for other Learning Designers new to the process.<\/p>\n<\/div>\n

\n
\"Admin<\/a>
LMO Admin User Guide<\/figcaption><\/figure>\n

Admin User Guide for a private Qld Gov’t social network site.<\/p>\n<\/div>\n

\n
\"Member<\/a>
LMO Member User Guide<\/figcaption><\/figure>\n

Member User Guide for a private Qld Gov’t social network site.<\/p>\n<\/div>\n

\n\n <\/div>\n","protected":false},"excerpt":{"rendered":"

Examples The following examples of technical writing and tutorial documentation are exclusively conceived and written by myself. I was contracted by the Queensland Dept of Health to finalise their UX research and implement their IA redevelopment for the Human Resources intranet. My key outputs included designing the UI elements, coding a HTML5\/CSS3\/Javascript framework and applying […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":241,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"builder_content":"","_links":{"self":[{"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/pages\/4331"}],"collection":[{"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/comments?post=4331"}],"version-history":[{"count":19,"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/pages\/4331\/revisions"}],"predecessor-version":[{"id":4489,"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/pages\/4331\/revisions\/4489"}],"up":[{"embeddable":true,"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/pages\/241"}],"wp:attachment":[{"href":"https:\/\/www.jasonshanks.com\/wp-json\/wp\/v2\/media?parent=4331"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}