Every Page is Page One

Mark Baker

• Éditeur: XML Press
• Année: 2013
• ISBN:
  9781492001928
• Édition: 1
• Sujet: Computer Science
• Sous-sujet: Computer Science General

The Web changes how people use content; not just content on the Web, but all content. If your content is not easy to find and immediately helpful, readers will move on almost at once. We are all children of the Web, and we come to any information system, including product documentation, looking for the search box and expecting every search to work like Google. There is no first, last, previous, next, up, or back anymore. Every Page is Page One.

In this ground-breaking book, Mark Baker looks beyond the usual advice on writing for the Web, and beyond the idea of topic-based writing merely as an aid to efficiency and reuse, to explore how readers really use information in the age of the Web and to lay out an approach to planning, creating, managing, and organizing topic-based documentation that really works for the reader.

Every Page is Page One

Topic-based Writing for Technical Communication and the Web

Mark Baker

Foreword

DTRITTRPATRTITRLAFOTDOTCC is probably the longest acronym you’ve ever run into. While it doesn’t roll off the tongue easily, and it’s difficult to memorize, it is the acronym that most represents the intent of the modern technical communicator:

To deliver the right information to the right person at the right time in the right language and format on the device of the customer’s choosing.

How to go about accomplishing this goal has been the focus of technical communication and content strategy thought leaders around the globe. Ann Rockley, Rahel Bailie, Sarah O’Keefe, Robert Glushko, JoAnn Hackos, Joe Gollner and others have spent considerable time thinking through the challenges involved in accomplishing this lofty goal. They (and others in our field) have developed, tested, and implemented methods, standards, and tools designed especially for tackling this challenge. And, they’ve willingly shared best practices and lessons learned discovered along the way.

Out of this body of knowledge came important innovations – single-sourcing, multi-channel publishing, component content management, and structured authoring – process improvements that resulted in the elimination of unnecessary manual tasks, the automation of tasks best performed by computers, and tremendous savings in content destined for translation.

While there is no doubt that these efforts created tremendous value for the organizations we serve, did these improvements help us create better content?

In Every Page Is Page One, Mark Baker argues that our focus on serving the needs of the organization has done little to improve the usefulness of our content. Single-sourced, multi-channel, XML publishing projects can indeed help organizations save money (compared to less efficient production methods), but these methods don’t do much to improve the value of the content to those who matter most: our audience.

While not everyone will agree with his thinking, Baker makes valid points that deserve to become part of our professional discourse. For instance, why do documentation projects continue to follow outdated publishing models? Are DITA topics appropriate for the web? Are they really self-contained information modules? And, assuming they are, do they provide the context required of people who stumble across them while foraging for information in a web browser, perhaps on a tablet or a smartphone?

Part manifesto, part textbook, Every Page Is Page One should be required reading for all technical communication professionals. Not only is this book loaded with thought-provoking ideas about how we might increase the usefulness of the content we create, it’s also loaded with information that software and services vendors need in order to create tools that help technical communicators DTRITTRPATRTITRLAFOTDOTCC.

My advice: Read this book and take its lessons into account when you create your next documentation project. If you do, chances are you’ll improve the utility of your content and dazzle your audience. Who knows, you might even create content that your customers find useful – content they might actually want to read.

Scott Abel
The Content Wrangler
October 2, 2013

Preface: In the Context of the Web

There is a scene in the James Bond movie Skyfall in which Bond approaches the bad guy’s lair, an island covered by spooky abandoned tenements. It is a striking image, so while I was watching the scene, I pulled out my phone to see if it’s a real place. It is. It is Hashima Island in Japan, an abandoned mining town. I’m not alone. Going online while watching TV is something most people do these days.^[1]

In addition, I use Google Maps to follow the hero’s journey when I am reading fiction and to check assertions and follow tangents when I am reading non-fiction. Even when the content I am consuming is not on the Web, I am.

This is highly important because it means that there is really no such thing as off-line content anymore. Even if the content is not found online, it is consumed online because the reader is online. This means that the way readers consume content online is now the way they consume all content, because they are always online. All content is consumed in the context of the Web.

Gerry McGovern reckons that the very idea of “going online” is outdated. We simply are online, all the time. “The Internet has become so pervasive that people don’t think they are on it anymore, even when they are.” ^[2] Today we live, work, and read in the context of the Web.

When I was growing up, I had access to a town library, a bookstore at the mall, and a university library. I thought I was living in an age of information abundance. Today I realize that I was living in a age of information scarcity that was, in terms of practical access to information, closer to the middle ages than to the modern world. We live in an age of cheap and abundant information. Of course, abundance is not the same as quality, but abundance on this scale profoundly changes the culture and economics of information.

Technical communicators must adapt to these changes as they design, organize, and deliver content. They can no longer create help systems and manuals as they have in the past; customer expectations have changed too much.

Even for documentation that is not on the Web, all the recent customer feedback data I have looked at indicates that users do not think in terms of individual manuals and references. They only think of “the documentation,” and they expect to be able to search and navigate it as one resource. Even if the documentation is not on the Web, readers expect every search to work like Google and every documentation set to work like the Web.

I call this change of expectations: Every Page is Page One. People have multiple sources of information available all the time, and they hop freely from one to another. Authors don’t dictate the reading order, readers do. And with every hop, readers arrive at a new page one.

Every Page is Page One is both an information design pattern and a content navigation pattern. For readers who live and work in the context of the web, Every Page is Page One is the dominant mode for finding and using information. Even if your content is not (or not yet) on the Web, you and your readers are best served by content that is written and organized for this new reality.

In this book, I discuss how the Web has changed the way people find and use information, how to adapt to these changes, and how to create content that is usable and navigable in an environment where Every Page is Page One.

1. Audience

This book is for technical writers, information architects, content strategists, and anyone interested in designing information that will be consumed on the Web or in the context of the Web. Even if you produce manuals and help systems, your users now consume your content in the context of the Web, with beliefs and expectations formed on the Web. This book is for you too.

Every Page is Page One is an information design pattern, not a technology. You can create Every Page is Page One content in any medium and with any authoring tool. Though certain kinds of tools can definitely help, Every Page is Page One does not require a tool change. Whether you work in DITA, FrameMaker, Word, a wiki, a Web CMS, or with pen and paper, this book is for you.

---

^[1] http://www.huffingtonpost.com/2013/04/09/tv-multitasking_n_3040012.html

^[2] http://www.gerrymcgovern.com/new-thinking/there-no-such-thing-internet-or-web-anymore

2. Discussion

Since well before I even thought of writing this book, I have been blogging about the Every Page is Page One concept at EveryPageisPageOne.com . Some of the material here originated on the blog, but this book is not a collection of blog posts. However, the blog is a good place to talk about the book and the concepts it champions, and I invite you to do so. The blog also contains a ongoing list of places where you can find Every Page is Page One content.

You can also discuss the book on the Every Page is Page One group on LinkedIn.

3. Acknowledgments

Many smart and kind people, including many leaders in the field, have influenced this book, both directly and indirectly. A number of them graciously provided comments and suggestions that led in many fascinating directions, not all of which I have had the time, or space, or wit to follow. Therefore to all who read I say, this book is not, for me, a destination but a milestone. There is further, much further, to go.

Thanks are due to:

My wife, Anna, for saying “stop talking about it and just get on with it.”

My publisher, Richard Hamilton, for saying “I’d like to publish it,” and a great many other useful things besides.

Everyone who has commented on my blog, particularly those who have held my feet to the fire and forced me to really think through and properly support what I was trying to say. To name a few: Scott Abel, Alan Brandon, Frank Buffum, Pamela Clark, Ray Gallon, Vinish Garg, Anne Gentle, Joe Gollner, Yuriy Guskov, Alan Houser, Steve Janoff, Tom Johnson, Marcia Johnston, Neal Kaplan, Alex Knappe, Larry Kunz, Jonatan Lundin, Gordon McLean, Paul Monk, Joe Pairman, Tim Penner, Myron Porter, Ellis Pratt, Ann Rockley, Barbara Saunders, Dan Schulte, David Singer, Val Swisher, Kai Weber, Leigh White, and David Worsick.

My fellow tech comm and content strategy...