Becoming a Better Writer
(How to be an effective Instructional Designer, Story Teller, Subject Matter Expert or Technical Writer)
Writing is something that we all do every day in one form or another, so how do we become better at it? I was asked to teach an effective writing seminar at my job recently and this blog is the content of what I shared with my class. In this case, my class was a team of Computer Programmers, QA Testers and Technical Writers who were assigned with writing white papers on technical topics such as Robotic Process Automation (RPA), Chat bots, Machine Learning and OCR technology.
These are some of the notes and ideas that I shared with my class and hope it will benefit you as well.
1.
Take a boring topic that is hard to learn,
technical in nature or that can solve a problem.
2.
Teach it to yourself first to gain a full
understanding.
3.
Then teach it to others by sharing your
learned knowledge.
4.
Package your story in a nice package and
present it. The package could be a website, a blog, an animation, a video or a white
paper. The idea is if you can tell your story, then you can put it in any
format you want and tell it different ways. We can also use this same format
for writing a course, teaching a class or creating a blog or Instructional
Design website.
Everyone has a story to tell but the format can change from person to person depending on your audience.
Your story is your topic and the package or format is your white paper. So let’s move on to how to tell your story and put it on paper.
Do Your Homework
1.)
Learn your subject by teaching it to yourself.
Be the subject matter expert. In other words, the best way to learn something
is to teach it either to yourself or to someone else. “The only way to do it is
to do it” (or research it and teach it) and that is what you are doing with
your paper.
2.)
Gather and compile your Research. When you
first start writing, gather your research and ideas in a free form format. Put
your ideas on paper and don’t worry about how they look. Do your research,
gather links from web pages or put your ideas on paper to start. If you think
of an idea, write it down. The idea here is to focus on a free form flow of
ideas to help gather your thoughts and ideas. Once you have your content
written out, the next step is to focus on organizing your ideas to tell your
story.
Write a Table of Contents
1.)
Write out the main thoughts of your paper by
creating a table of contents. The table of contents can change and be flexible.
Creating a table of contents is an effective way to organize your main thoughts
in an outline format to help organize your paper.
2.)
When writing your actual content, organize
your main ideas and content down into chunks or smaller paragraphs and
chapters. The smaller the chapters are in a book, the more you want to read
because you feel like you can read the book faster and it does not drain you
physically. In the Instructional design world, we refer to this step as ‘chunking’
as you are literally breaking down your content into smaller, more manageable ‘chunks’
of content.
3.)
Keep in mind that readers want to glean
information from your papers so keep it simple. Very straight forward.
4.)
Explain the subject like you were getting up
in front of a group and talking about it. If you can read your own paper and
talk through it out loud, to sound it out and see if it makes sense to you.
Writing Your Content
1.)
Organize your information into an outline. Take
your ideas and put them in an organized table of contents. You start with the
table of contents to help you do two things – To give you an outline and two to
give you a summary and a starting and end point. So you are laying out your
paper and organizing your thoughts.
2.)
Tell your story (Read your paper out loud). Write
your paper as though you were going to have to read it out loud and give an
oral presentation. If you read something and it does not make sense, re-write
it in your own words so that it makes sense to you.
3.)
Use white space to be easy on the eyes. Between
your paragraphs and use short concise chapters. The best books that are the
easiest to read have short chapters.
4.)
Think about your audience and how to teach
your subject to anyone off the street. Word smith and make sure your words are
your own and make sense to you and to others.
5.)
Provide References for quotes and ideas. If a
thought or idea is not your own, make sure you add a reference as to where the
idea and thought came from by using APA Formatting.
6.)
Use illustrations and images to support your
paper and draw the eye, convey and teach. Appeal to different learning styles.
Some people learn visually, some aurally and some learn by just reading.
7.)
Provide examples, tutorials and further
reading to further support your topic.
8.)
Read technical manuals, journals and
magazines. Some of the best UI Design examples you will ever find are in
magazines. The layouts are meant to draw the eye and get you to read further by
using color, layout and interesting articles and writing style.
9.)
Spell check and proof read and get some else
to read it. If it does not flow or make sense, rewrite it but in your own
words. Remember this is your story you are telling.
10.) Package
it up and sell your idea. Add graphics, colors, layout, and illustrations to
help tell your story and keep your readers engaged. In most white papers, you
don’t have these things but they are nice to add and help tell your story.
11.) Practice
writing but have fun with it. Write and write even more. Write grocery lists,
write poetry, write stories, and create a diary. But practice telling your
story and in your own words. If you want to get good at something, practice,
practice and practice some more. The key however, is to have fun with it and
enjoy the process.
The same principle applies for learning to play a musical instrument, painting, photography or writing a poem. Writing is an art form but it is one of the most important forms of communication we have. Every day you are writing in one format or another.
Dealing with Writer’s Block
Every good writer experiences this problem from one time to another as well as any good artist or creative person. When you feel you are hitting a wall with your writing, take a break and relax. Put your pen down and walk away from the task.
As any good Computer Programmer can tell you, some of the best solutions to writing good code and solving a complex problem, come to you when you are driving down the road, relaxing at dinner or just going for a walk.
Give yourself a mental break, relax your mind and let the creative process come to you. Creativity comes from a mind at play and rest, not a mind stressed out and overworked.
Keep a note pad with you handy at all times, especially late at night. Often when you wake up in the middle of the night, creative ideas will come to you so keep a pen and notebook handy to write down those ideas.
What you Gain in Return
1. Knowledge
(you become the subject matter expert).
2. The
ability to teach and effectively share that knowledge.
3. Credibility
to be able to learn that knowledge and share it among various types of media.
4. And
finally, gaining skills to pay the bills.
About the Author
Rick Short is the Creative Director for Scenic Earth Studios and has worked in the creative and technical fields for over twenty years building websites, QA testing software and writing Instructional Design and E-learning courseware for K-12 and Adult learners.
Visit his website at www.ScenicEarth.com to get in touch or visit his portfolio of artwork.