Cut, Cut, Cut your Content and Procedures

Sure. We’ve been reducing word count in procedures for some time. It’s time to do more, however. As noted in an earlier post, we have to think mobile. Think small screens and small devices. Screen real estate will be at a premium.

2moro Docs (2009). Articles>Documentation>Technical Writing>Minimalism

Write Everything as if Writing for the Web

Writing tightly means packing the most information into the least amount of space. It's not easy, but when you do it, the result is like magic. The key to being an effective writer is to keep what you’re writing short, to the point, and easy to read. Like the best writing on the Web.

Nesbitt, Scott. ScottNesbitt.net (2009). Articles>Writing>Advice>Minimalism

The Minimalist Principle: Omit Needless Things

Minimalism is something people might strive for, but they don’t know where to start.

Babauta, Leo. Zen Habits (2009). Articles>Writing>Minimalism

Plain English Is the Best Policy

The health care reform bill now under consideration in the House of Representatives includes a proposal that certain disclosures in insurance policies be made in “plain language.” Another piece of legislation now being considered by both houses of Congress would likewise require uniform and simplified coverage information, much like what’s required on nutritional labels. These are excellent proposals, but they do not go far enough. Plain-language disclosures of some policy information and consumer-friendly labels are no substitutes for making an entire policy readable.

Cogan, John Aloysius. New York Times, The (2009). Articles>Writing>Policies and Procedures>Minimalism

More Tips for Writing Well

Be vicious when you edit. Vicious. Follow these recommendations with zealous fervor. They help your writing say what it should in a way we’ll understand.

Govella, Austin. Thinking and Making (2009). Articles>Writing>Editing>Minimalism

Sometimes, Simple is the Way to Go

I’m advocating boiling the documentation down to the essentials. Remove any superfluous material. Tell the user how to do things with a piece of software or a gadget, not what that something can do. You might wind up with documentation that’s just a set of procedures connected together by linking material and cross references. Don’t bog them down with what’s not necessary for them to get things done in a fast and efficient way.

Nesbitt, Scott. Communications from DMN (2009). Articles>Documentation>Technical Writing>Minimalism

Duct Tape Technical Writers

In reality, the user just wants a brief, clear explanation of a concept or task. The user will glance and skim — reading behaviors hardly worthy of the elitist grammarian who argues the finer points of “which” versus “that” in restrictive clauses.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Document Design>Technical Writing>Minimalism

Minimizing Documentation

Is less always more? I’m not sure. But if Apple’s minimalistic designs are any indicator of trends, minimalism in documentation is something to pay attention to. Here are five ideas for minimizing documentation.

Johnson, Tom H. I'd Rather Be Writing (2009). Articles>Documentation>Technical Writing>Minimalism

Minimal Procedure Content: Reasoning

The procedure I wrote about creating a Twitter list uses abbreviated content. This post describes the reasoning behind and decisions made in writing the topic.

2moroDocs (2009). Articles>Documentation>Technical Writing>Minimalism