Category Archives: TC

TC, Technical Communication

Writing for the Web – Simplify Your Words!

What does writing for the web mean? Do we write in a way that is simple for anyone to understand? I keep going back to my technical communication college days and wonder what it means to write and I go back to my first technical writing job that I had which I was introduced to Plain Language writing style.

What I learned from understanding Plain Language: write stupidly simple. Why? The internet is not entirely a formal place for communication and most of the time its to share information.

Nowadays, I think that effective communication should be simple, easy, short, and to the point. Does that mean I’m lazy? Can I use complex language to transfer my knowledge to someone else or can I use simple words to get my point across? You be the judge of that last sentence.

Even during WWII, Winston Churchill wrote a memo which asked for simpler language when communicating within his team. He wanted short and crisp messages, include headers, and remove “wolly” phrases because he felt it was merely padding. Why? He didn’t want his staff to waste time reading long reports when there is a war going on.

Getting back to web writing: there is a lot of stuff written out there for anything. As a technical writer, how can we simplify what we write? Rewrite a sentence? Make it easier to understand? Can we save someone’s reading time?

My job these days is to convince stakeholders that easier and simpler content will make their jobs easier and their customers fully figure out a process without stopping in the office or making a phone call. [Edit–I had an entire paragraph written before writing this next one] Basically I help remove complexity, make stakeholders happy, and customers happy.

Drilling down to my point: make your job easier to make your reader’s job easier with clear content.

My recommendation is check out Marcia Riefer Johnston’s books, Word Up! and You Can Say That Again. These books are great resources to improve your writing skills. 🙂

Template Refresh for 2015 and Beyond

Over the weekend I changed the theme of my website once again. This theme is the third iteration since 2011. I decided to go to with a theme created by Automattic, the people who create WordPress.

WriteTechie - Light Theme Color

Write Techie – September 2011

Why was it time to change? I wanted to start with a clean slate. As a web developer, I experimented with minor improvements to an old theme for better functionality. At some point those changes got in the way and caused more harm than good.

I decided that trashing an old design I’ve customized for years and start something new was a better solution. In this case, it’s not as new as you might think. I chose a familiar WordPress theme that I’ve used on another website for a few years.

Write Techie - September 2015

Write Techie – September 2015

I also want to emphasize the current trends of web design and writing in this version of my template refresh.

Fonts

Despite higher screen resolutions on mobile devices, sans-serif fonts are still better to read than serifs. They’re still great to use, but serifs are better for printed material. I chose to cut the serif fonts in favor of sans-serif for the reason that it is easier to read on screens.

Responsive Design

There is nothing new here except to make sure that any website is responsive to an unlimited number of screen sizes and resolutions. There is no excuse for websites to show up incorrectly on an iPhone, a 32-inch monitor, or a display on Times Square.

Simplicity

Web writing is a completely different world than other types of writing. Keeping it simple will give users the right information the first time and show them how to do the tasks they came for.

Content

As with any template refresh, so comes the content. The more concise, the better.

Drawing

Communicating Our Differences

Argh!!!!

Ever wonder why sometimes the other person on the other end of an email, phone, or conference room doesn’t understand what you say? Try this activity out and reflect on your experience!

One of the neatest exercises I’ve done was write a procedure for drawing one of the world’s famous cats, Garfield. (Yes, I am aware that Hello Kitty is another famous cat). We were given a picture of the feline and told to write instructions for about ten minutes. Then we passed that sheet to our neighbor and asked them to draw Garfield based on those instructions–literally.

Reading someone else’s instructions is an interpretation of what they see that you should understand and perform. Sometimes those instructions are vague and not clear. Whatever the case, the task was to draw the cat the way you read their instructions.

Smug Looking

My drawing was ugly, but smug. I took the instructions literally and came up with what I thought Garfield was supposed to look like.

Drawing

Drawing

The purpose of the exercise was to understand that we need to communicate in a clear and concise way that can lead others to understand us. Also this exercise gave us the opportunity to see how other people interpret our instructions. We can see difficulty communicating our thoughts easily and how those thoughts can be hard for someone else to understand.

Mind blowing? Yes! Not everyone understands the way you think and you can’t assume they can figure out what you say.

Thoughts to Consider

Think about it the next time that you communicate, are you:

  • communicating clearly?
  • writing concisely?
  • understanding where others stand?
  • making sense?