Kinds of Writing

Based on chapters of Technical Writing for Engineers and Scientists, Barry J. Rosenberg, and resources linked inline.

Kinds of Writing

The “writing” we have been talking about has generally been abstract: maybe a “report” or just generic “sections”.

But the style of writing will depend on what you're writing: email is different than a research paper. Let's talk about a few that you might be likely to do…

Web Sites

Web sites can't rely on the linear beginning-middle-end structure that a paper-based document has. It's a… web of information.

See also How Users Read on the Web and Applying Writing Guidelines to Web Pages by Jakob Nielsen.

Web Sites

As with any writing, you should start by figuring out the purpose of your site, your intended audience, the content do you want to include, etc.

Especially on the web, readers probably won't want all of what you're going to write. They want a specific topic or even single fact.

Web Sites

Instead of ordering the content, we need to break it into not-strictly-ordered pages.

People may arrive on any page, coming from external links, search results, etc. You can't assume that they read the “previous” content on your site, or even followed your navigation structure.

Web Sites

Even within a page, readers don't read top-to-bottom.

Making your content scannable will make it much easier for readers to find what they want.

Web Sites

There are several ways your markup can to make it easier to scan for relevant info.

  • meaningful headings on sections (<h2>, <h3>)
  • highlight keywords (<strong>, <em>) so they can be easily seen
  • lists (<ul>, <ol>)

Web Sites

One thing that stands out to be scanned: your links. They should be meaningful and suggest the destination.

Click here for our schedule.
You can also check our schedule.

Web Sites

Your writing can also help readers find what they want.

  • Keep your paragraphs (or other blocks) short: one idea each.
  • Introduce your main point as early as possible: hopefully on the first screen.
  • Write less: more concise than you might in other contexts.

Web Sites

Design the navigational hierarchy of your site to help users find what they want.

Once again, think about the needs of your audience and how they might think about your content (not about your org chart, etc).

Plan for growth: a web site is a living thing, and you'll want to add pages later. Create a structure where that can be done sensibly.

Web Sites

Don't forget all of the other stuff we talked about: your content should be made easily readable with all of the tricks we have talked about.

Email

Let's face it: we all write a lot of email, like it or not. Getting your point across by email is an important professional skill.

See also: Once Upon a Time: communicating at work; Email Tips: Top 10 Strategies for Writing Effective Email; Writing Effective Emails.

Email

I propose that the usual problem with emails is giving the right information for your reader(s).

Once again, you must think about your audience and figure out what they need to be told to understand.

Email

Don't say too much.

Most of what you write is going to be to co-workers. They will already know a lot of the context of the situation and don't need to be told again.

The longer the email, the less the chance of it being read fully.

Email

Don't say too little.

Your reader(s) need to know what's going on, and the context of your message.

Email

Keep the message focussed and on a single topic. Be brief and to-the-point.

Like with web pages, you probably need to be more concise than a long form report or similar.

Email

But don't let your email degrade to text messages.

I neeed your report by 5 pm.

Give it a proofread before sending too.

Email

Email often replaces face-to-face communication, but without the body language and vocal tone. Make sure the tone of your writing is appropriate.

I need your report by 5 p.m. today or I'll miss my deadline. Writing Effective Emails
Hi Firstname,
Thanks for all your hard work on that report. Could you please get your version over to me by 5 p.m., so I don't miss my deadline?
Thanks so much! Writing Effective Emails

Email

Have a meaningful subject line that explains the topic.

Think of the subject as (briefly) doing the job of the introduction: orienting the reader and saying something about the context & problem.

Subject: meeting
Subject: Foo project meeting
Subject: Foo project meeting Thursday?
Subject: Foo project meeting Thursday 10:30

Email

On the subject of your audience: choose them carefully. Send to the right people!

Don't CC the whole company, or others that don't care.

Presentations & Slides

In some ways, a slide-based presentation is like any other writing.

Think about who your audience is, what they are interested in, and what they need to know.

Presentations & Slides

You'll need an introduction, main body, and conclusion. ReadersThe Audience should always be oriented to the topic, and know the context.

Visualizations should use the graphical languages well to convey information.

Presentations & Slides

But there's an extra dimension of timing and of you talking about the material while the audience is seeing the slides.

Presentations & Slides

Remember that the slides you make aren't the whole presentation.

The extra “you talking” part will add a lot of the content.

Presentations & Slides

Implication: you don't have to write everything on the slides.

Slides can hold just the main points.

Presentations & Slides

Since the slides must be consumed in real-time as you're talking, they should be as concise as possible.

  • Bullet points might be better.
  • People don't write long bullet points.
  • The format encourages brevity.

Presentations & Slides

I haven't been using bullet points much in slides.

  • I have been writing paragraphs.
  • Reminds me to write full sentences as examples.
  • Usually 1–2 sentence paragraphs.
  • One-at-a-time appearing bullets are annoying, right?

Presentations & Slides

Make a number of slides that's reasonable for the presentation length.

Rosenberg suggests 80 seconds per slide, which seems reasonable. (≈37 slides for a 50 minute lecture)

Presentations & Slides

As always, it depends on the subject, audience, etc.

  • Complex data/visualizations: more time per slide.
  • More mid-presentation questions: more time per slide.
  • Pictures with little logical content: less time per slide.

Practice the talk to see how the timing works.

Presentations & Slides

How I feel about an n minute presentation:

  • 0.8n: maybe it's time for questions.
  • 0.9n: maximum time you should plan to use.
  • 0.95n: nobody is listening.
  • 1.0001n: shut up. You are a horrible person if you're still talking.

Presentations & Slides

Mechanics:

  • Know how to get the projector (and audio) working.
  • Contrast on projectors isn't as good as your screen: be careful with subtle colour.
  • Fonts (especially code examples) need to be big.
  • Similarly, diagrams should be simpler than on paper.

Presentations & Slides

Did you know that it's physically possible to give a presentation without slides?

Many people don't seem to. Slides can be effective, but aren't the only way.

Presentations & Slides

Other presentation styles to consider:

  • No slides, just really good talking.
  • TED style: slides are just pictures to reinforce the message.
  • Live whiteboard (or chalkboard or overhead projector) writing and diagramming.

Choice depends on the audience and material.