Minimalist Writing

Minimalist writing has been around for almost 20 years. The minimalist movement started with John Carroll’s book The Nurnberg Funnel: Designing Minimalist Instruction for Practical Computer Skill published in 1991 by M.I.T. Press. (1)

For many professionals who may their living as technical writers or technical communicators, this book forms an essential foundation in writing quality technical documentation. Carroll’s approach is to focus technical documentation on how users work, not how the system works. Or, to put it differently, focus on tasks users will perform with a system (hardware, software, service, or any combination) and not on the features of the product. Carroll presents significant research to support his argument and also provides examples in the texts to illustrate his points.

Technical writers who need to reduce the volume and complexity of their content should read Carroll’s book. It will help you to reduce the cost to develop, produce, and maintain technical documentation. It will also demonstrate ways to decrease the time and effort needed to work with content and improve the quality of your deliverables.

Anyone who is charged with writing documentation should read this book. It will change your point of view and your readers will love you for it.

Notes

(1) M.I.T. Press published a related book, Minimalism Beyond the Nurnberg Funnel, in 1998.

Resources

The EServer Technical Communication Library

Where to go for more minimalist information

William Strunk, Jr. and E.B. White, The Elements of Style

Recognizing the Value of User Assistance

WritersUA has been using the tagline of “Better UX through Better UA” for many years, perhaps since the late 1980s and early 1990s when they were known as WinHelp Writers. (It’s too long ago to trust my memory on this fact. Joe Welinske, president of WritersUA, could probably help me out.)

For the uninitiated, “UX” means “user experience” and “UA” means “user assistance.” What is user assistance? Wikipedia defines it as:

“a general term for guided assistance to a user of a software product. The phrase incorporates all forms of help available to a user. Assistance can also automatically perform procedures or step users through the procedure, depending on the question that the user asked. The term is broader than online help, and includes procedural and tutorial information.” (1)

I like the general Wikipedia definition especially the phrase “all forms of help available to a user.” Our best customers understand the benefits of making an investment in quality UA to improve their customers’ experience. They don’t want to overburden their technical/customer support teams; reduce the bottom line; or risk damage to the company’s reputation if their customers are not happy. Anyone who purchases electronics with technical documentation translated into Chinglish or Japanglish has experienced these frustrations first-hand.

In terms of TRA360, user assistance includes our technical documentation and learning & development practices. Let me know if can help YOU.

Notes

(1) http://en.wikipedia.org/wiki/User_Assistance

(2) Ibid.

The Content Wrangler

Have you ever heard of Scott Abel or his website The Content Wrangler? If not and you’re a technical documentation or social media pro, start reading. Better yet, bookmark the site and subscribe to the RSS feed. You can also sign up for the e-newsletter, follow Scott on Twitter, or join his Facebook community.

I rely on The Content Wrangler for blog posts, podcasts, and archives on technical documentation. They keep me up-to-date on content management strategies and technologies, using social media in the enterprise, DITA for technical writing, and lots of other important topics. Scott’s opinions are direct and no-holes-barred. A recent post entitled “Facebook Faux Pas Number Two: A User Experience Only Programmers Could Have Devised” is a perfect example.

Scott’s been at this game for a while—his blog archives date back to September 2002—so his experience is deep and wide. While you might not always agree with his opinions, you’ll always receive enough information to make sound business decisions.

Do you need help in wrangling your own content? Contact Valentina Rosa for advice.