Archives for 

Tools and techniques

Workshop Review: UX Methods for Technical Writers

Rebecca Cox’s UX Methods for Technical Writers workshop (Monday 24th July, Quality Hotel, Parnell, Auckland) promised to take you deeper into the area of User-Centred Design (UCD) where you’d learn methods to help you align your documentation to your users’ needs. Did it deliver?

About the presenter

Rebecca’s skills lie in user research and usability testing for websites with a focus on uncovering inadvertent usability problems. She is passionate about enhancing users’ experiences and openly shared examples from her working background to highlight points throughout the day. The same methods she uses for websites can be applied not just to technical documentation but various other forms of media we use to communicate with our users.

About the workshop

The workshop began by looking at what UX is and what is required to enhance a user’s experience.  This was not just in our documentation, but also in ourselves and the skills we need.

From there we looked at different scenarios to use as the basis of our investigations throughout the day. As the number attending the workshop was small we worked on these individually instead of in groups, allowing us to choose a topic that we could easily relate to.

The remainder of the morning was spent applying the core methods of testing User-Centred Design (UCD) to our chosen scenario. This involved using tools provided by Optimal Workshop to:

  • create and conduct surveys and interviews;
  • identify how users understand and categorize information; and
  • test if users can find what they’re looking for quickly and easily.

After lunch we prepared and carried out an in-person test session for our scenario. This involved setting tasks designed to test usability or comprehension. We asked our participant to complete a task with the items to hand and encouraged them to ‘think aloud’ in order to follow their thought process. This method very effectively highlighted usability issues and pain points. It allowed insight into what our users really think about the structure and content of the media used to deliver technical communication.

Following each test of our scenario we recorded the results and our findings. We reflected on each session, what we learnt and how we could improve it for next time.

To finish we looked at other analytical tools for investigating UX and analysed the results of our surveys, interviews, in-person tests, and other testing methods used throughout the day.

About my experience

Following Rebecca’s introductory webinar I was eager to learn more from her, about website design in particular. This was my main reason for attending the Auckland workshop however I was also interested to see how her techniques could be applied to written documentation.

My focus for the day was on website design so it was easy to see how the tools we were introduced to could help. They are on-line tools and are intended to help make design decisions for websites. Card sort, Chalkmark, and Treejack are all now part of my toolset which will be called into action in the near future when I begin the redesign of our company website. At the same time I could also see how these tools can be applied to testing the usability of on-screen help, knowledge bases, and even written docs if you have an on-line version.

As technical communicators it is vital to know and understand our user’s needs. Sometimes it can be difficult to know if the material we are producing is giving our users the best experience possible. Using the methods demonstrated by Rebecca in her workshop is definitely an effective way of finding out, from the users directly, if our communication is exemplary. If you’ve ever wondered if the way you’re delivering your message really is the best way, then using Rebecca’s methods would definitely give you an answer.

Online Accessibility – Making the web accessible to everyone

Peter Nock reports on the July branch event in Christchurch. Having been to the workshop on accessibility at the last TechCommNZ conference, I was keen to hear more on the topic of accessible documentation. Kevin outlined some of the obvious (plain language, use of styles) and less obvious (text for form boxes, how machine readers […] Continue reading →

Webinar Review: CSS Colors Demystified

Presented by Dave Gash www.davegash.com Dave Gash’s recent webinar, CSS Colors Demystified, provides a clear and entertaining explanation of how the hexadecimal color coding system works. For those of you who like to know what lies behind the letters and numbers, Dave explains how the physics of colour relates to the base 16 hexadecimal coding […] Continue reading →

Christchurch Branch Report: There and Back Again: A UK XML Tale

The Christchurch branch of TechCommNZ doesn’t mess around. After a well attended 2016, the 2017 season started with a hiss and roar with a good number turning up to hear James McLaughlin talk about his time in the UK working as a technical communicator in the “chip” industry. James’s funny and informative talk covered his experiences writing […] Continue reading →

Making MS Word Tables work for you – Part 3

(The following text has been adapted from Wempen, F. (2013). Word 2013 In Depth. USA: Pearson Education, Inc.) This article is a little late because I have just completed one of my bucket list items – cycling the Karakoram Highway from Gilgit, North Pakistan to Bishkek, Kyrgyzstan. The adventure was all I had hoped for […] Continue reading →

Making MS Word Tables work for you – Part 2

(The following text has been adapted from Wempen, F. (2013). Word 2013 In Depth. USA: Pearson Education, Inc.) Continuing from last month’s table topic, making MS Word tables work for you, this blog includes three more tips when working with tables. How to: Indent a table Set internal margins for an individual cell within a […] Continue reading →

Screenshots in User Documentation – An Opinion Piece

Last year, the most eloquent and investigative Earnsy Liu wrote a nice little article for TechCommNZ summing up the opinions and research (or lack of) into the use of screenshots in user documentation. It’s something I’ve always been interested in, as a long-time software documenter and creator of screenshots. Based on my recent experience as both […] Continue reading →

Making MS Word Tables work for you

(The following text has been adapted from Wempen, F. (2013). Word 2013 In Depth. USA: Pearson Education, Inc.) MS Word tables are great as an organisational tool that lets you present information in an interesting, easy-to-read format.  They are excellent for presenting text and graphics, creating a form or checklist.  You can also use tables […] Continue reading →

More time-saving Word tips and tricks from Catch-Up Training

This blog includes three practical Word tips, and shows you how to: instantly select a word, sentence or paragraph quickly format a word, paragraph, range of cells, textbox or autoshape using the Format Painter tool  insert a non-breaking space to keep adjacent words together Instantly select a word, sentence or paragraph This tip is an oldie […] Continue reading →

Microsoft Word Tips from Catch-up Training

Heather Wickham from Catchup Training offers us three time-saving tips when working in any version of Word. Avoid confusion using AutoCorrect This tip is very useful when you are writing and using the same word in a singular and plural context for example, battery and batteries.  The asterisk triggers the use of the AutoCorrect feature […] Continue reading →