• Home
  • Free Marketing Templates
  • Speaker
  • News
  • Events
  • Podcast
  • Blog
  • Contact
  • Search
Bluewire Media - Web Strategy
  • Home
  • Blog
  • Contact Us
  • More
  • Free Workshops & Mini-Trainings
    • Tips for LinkedIn Profile
    • Your Web Marketing Strategy (part 1)
    • Your Web Marketing Strategy (part 2)
    • LinkedIn Accelerator Exec Short Course
    • Build A Marketing Engine
    • Flagship Content
    • 3 Orbits of Marketing
    • 3 Steps To WIn High Value Clients on LinkedIn in 60 Days
    • Calendar Year Planner Guide
    • Weekly Content Planner Guide
    • How to win clients from email marketing
    • Marketing Mini Course – Tools of The Trade
  • Our Best Selling Book
  • Marketing Club
  • Marketing Coaching
    • Free Marketing Scorecard
    • Book 20 Min Growth Plan (free)
    • Coaching Program
  • Corporate Training
    • LinkedIn Marketing – Keynote Speaker & Coach – Adam Franklin
    • Accountants – Social Media Training
    • Financial Adviser – Social Media Training
    • Real Estate – Social Media Training
    • Mortgage Broker – Social Media Training
    • In House LinkedIn Training
    • In House Social Media Training
    • Digital Marketing Training Courses
  • Adam Franklin & Bluewire Media?
    • Meet Adam Franklin
    • 10 Reasons To Work With Us
    • Recognition
    • The Bluewire Story
    • Company Profile

Bluewire Media Web Strategy Blog

Home / A few moments with Lesley Hays….

A few moments with Lesley Hays….

Posted by Angela Logovik

Share
Share
Pin
Tweet1
1 Shares

Among your many talents (development, shopping, hula hooping to name a few) you’re also responsible for writing a majority of resource manuals for clients and internal process guidelines for Bluewire Media staff. One might say that you are our unofficial technical writer…

Bonus: Download the 33 free templates from the book Web Marketing That Works.

Where do you begin when first writing a reference manual?
As with any writing, it helps to start with general information and gradually become more specific.

In the case of a reference manual, I’d start with basic contact information for support, log in details, and an overview of the system to provide the user with a very basic starting point. Then start going into more detail, first about the consistent areas of the system (global navigation, common buttons etc.) and secondly, about really specific parts relevant only to that particular client.

Do you find it difficult explaining technical information to the lay person?
It can be hard, as simply replacing jargon with regular words doesn’t necessarily work. Sometimes the concept itself can be quite foreign making it very tricky to communicate even if using 10 year old English.

To illustrate, compare two explanations of a WYSIWYG editor:

Example 1
A WYSIWYG editor is a content editor that allows you to edit text, images etc and have them look how they will in the final context.

Example 2
A WYSIWYG editor allows you to update content on your website using tools similar to the basic functions of Microsoft Word. This means that you can see what the finished product will look like on the website before you hit save (and also you don’t need to know any code!).

How do you overcome this?
One of my favourite techniques is the analogy, which can help explain not just how something works but also why things happen. If you get an analogy wrong, though, it can make things even more complicated!

During your time at Bluewire Media how have your methods of writing improved /changed?
I’ve had lots of opportunities to get feedback from both colleagues and clients over the past couple of years, which has helped me discover what concepts and words the general public needs explained. It’s also helped me write instructions more clearly and even change my tack on reference manuals completely…

In what way have your made help information more accessible to clients?
The majority of the manuals I write are for content management systems. In the last few months, I’ve been experimenting with embedding the help information I write into the administration area of the system itself. This means that when a client has a problem entering content or editing something, the help information relevant to that part of the site is just a click away. So far, feedback on this technique has been positive.

How is writing a process for staff different from writing a reference guide for clients?
The main difference is the amount of background information required. Staff processes don’t need lengthy explanations or glossaries – they just launch straight into the meat of the document. I expect that the staff I am writing the process for already have the technical background necessary to understand the process.

How do you decide what processes need to be written?
Deciding what processes need writing is possibly more difficult than actually writing them! I’ve recently been doing just this for our development processes and I found the easiest way was to write a really general overview of our entire development process, then decide what parts of the process needed further explanation. I’ve created a list of required processes and am slowly making my way through them – I’m sure the list will change and/or grow as I write more.

Why go to the trouble of writing processes down? Can’t information be passed on verbally?
There’s nothing worse than wondering how to do something and thinking “I bet John Smith would have known…” if John left the company 3 months ago. Writing down processes regularly and thoroughly means that the company isn’t reliant on any one person – which lets them withstand sudden resignations or fast-tracked inductions far better.

Everything used to be passed on orally hundreds of years ago… then we invented the printing press. Now we have computers, so why look back?

I understand that you will be expanding on your technical writing skills next year. What areas of your writing do you hope to improve upon?
I’m planning on taking a technical writing course. The course focuses on communication around technical issues in general, so it’ll be useful for everything from internal processes, blog articles, help manuals and even everyday emails to clients.

Make sure you let us know how the course goes!

  • About the Author
  • Latest Posts

About Angela Logovik

  • The journey to a useful intranet [Part 2] – Quality Management - Dec 5, 2013
  • The journey to a useful intranet [Part 1] - Oct 24, 2013

Share
Share
Pin
Tweet1
1 Shares
2 Comments
Business
 0 Shares
Tweet

Posted on Dec 23, 2009

← Using social media as marketing tools A day in the life of a Bluewire Media developer →
  • Latest
  • Popular
  • Comments
  • Tags
  • 5 Commandments of Blog Branding Aug 3, 2022
  • Tips to Craft a Social Media Resume Jul 26, 2022
  • Fake negative comments Jun 23, 2022
  • 7 Offline Marketing Strategies That Your Online Brand Must Adopt Jun 17, 2022
  • How To Get Internet for Your Home in 3 Easy Steps Jun 13, 2022
  • Marketing experimentsMarketing Experiments: Email Content That Gets Clicked Apr 23, 2013
  • LinkedIn Marketing Strategy Infographic Nov 13, 2013
  • seo-secretsFishing for backlinks – Tips from SEO Secrets Oct 27, 2009
  • Your Ultimate Blog Checklist Jul 16, 2014
  • DanNorrisThe 5 Best Google Analytics Reports for Content Marketers Jan 8, 2014
  • Lifecycle Marketing vs. Traditional Sales Funnel - MarketingProfs.com - Gossip Buz […] map how customers will remain in your ma
  • Fake negative comments – Bluewire Media – wolfgangherfurtner […] Source link […]
  • Faux damaging feedback – Bluewire Media – Daily Business & Economy News and Information | Titan Business Consultants […] ← 7 Offline Advertising and marketing
  • Faux damaging feedback – Bluewire Media – Daily Business & Economy News and Information | Daily Business Digest […] ← 7 Offline Advertising and marketing
  • 7 Offline Marketing Strategies That Your Online Brand Must Adopt - applebusiness […] Resource website link […]
#thebigwet Adsense blue sky factory cara drolshagen copy customer relationship management Dibgy Ioane Dogpile education websites expert interview garageband geo location Gmail Google Earth googleplex Instagram Internet jack dorsey Jason Fried Know your mojo LinkedIn London riots mike lieberman networx NSBS online advertising Outlook 2010 password photography RichardatDELL simon townsend social media. business subfolders Successful Blog success insights sunday mail socials sydney tips Toby Jenkins user testing VA web development Wikis wireframing zuckerberg

Archives

  • 2022 (17)
  • 2021 (20)
  • 2020 (94)
  • 2019 (132)
  • 2018 (31)
  • 2017 (60)
  • 2016 (131)
  • 2015 (176)
  • 2014 (122)
  • 2013 (99)
  • 2012 (73)
  • 2011 (93)
  • 2010 (152)
  • 2009 (135)
  • 2008 (1)
  • Back to Top
    • Home
    • Free Marketing Templates
    • Speaker
    • News
    • Events
    • Podcast
    • Blog
    • Contact
    • Search
    • Bluewire Community
      • Free Marketing Templates
      • Amazon – Web Marketing That Works
      • Join our Faceook group
      • iTunes – Web Marketing That Works
      • Spotify – Web Marketing That Works
      • Bluewire Podcast
      • Recommended Reading
      • Online Tools
      • Student Centre Login
      • Subscribe to Bluewire News
      • Sitemap
    • Hire Adam Franklin to Speak
      • Social Media Speaker
      • Digital Marketing Speaker
      • Keynote Speaker
      • Marketing Speaker
      • LinkedIn Keynote Speaker
      • Harbour Space Uni Lecturer
      • Toby Jenkins
    • Adam Franklin – Awards Judge
      • Optus MyBusiness Awards
      • Real Estate Business (REB) Awards
      • Australian Broking Awards
      • Australian Accounting Awards
      • Women in Real Estate Awards
      • Better Business Summit Awards
      • Young Leaders In Finance Awards
    • Contributors To
      • The Australian
      • Sydney Morning Herald
      • Smart Company
      • Huffington Post
      • Convince & Convert
      • Hubspot
      • Problogger
      • Kochie’s Business Builders
      • Entrepreneur HQ
      • Dent /Key Person of Influence
      • Life Hacker
      • Quora
      • Medium
      • Elite Agent
    • Working with Bluewire
      • Hire Adam Franklin
      • As a Client
      • As an Affiliate
      • As an Event Attendee
      • As a Guest Blogger
      • As a Partner
      • Testimonials
    • Connect on Social Media
      • Adam Franklin on LinkedIn
      • Twitter
      • LinkedIn
      • Facebook
      • YouTube
      • Instagram
      • Pinterest
      • Slideshare
    • Disclosure
      • Disclosure & Terms and Conditions
      • GDPR Compliance & Privacy Policy
    Australia

    6/179 Baroona Road
    Paddington
    QLD 4064

    Copyright © 2022 All contents Creative Commons Licensed Bluewire Media Pty Ltd.