writing reusable content

Pamela KosturPartner

Parallax Communications

Writing Reusable Content

© Parallax Communications 2007

Introduction

Let’s think about reusable contentShould we reuse content?Why? Why not?How?What makes content reusable?


Is this reusable content?


What about this?


Is this repetition necessary?


Which description is accurate?


So, why reuse content?

Writing for reuse is efficientReused content is consistent; no discrepanciesReused content is based on standards, which can improve usabilityReusable content is written in modules that help users to navigateReuse provides continuity


Issues with content reuse

In theory, it’s greatNot always easy to do

Authoring is different; topic-basedNeed to be able to find reusable contentPlanning and standards are criticalPlanning takes time


Planning for reuse

Reuse doesn’t just happen—you need to plan for itFirst, analyze content to determine where it can be reusedThen, determine structure to allow reuse


Example

You work in a wireless communications company and produce documentation for several audiencesThere is significant overlap and you want to reuse content


Example, continued

Your reuse plan might look like this:


Structure & content reuse

How content is structured affects its reuse

If you are reusing a product description, it must be structured to support reuse

Reuse must be transparent to both users and to authorsConsistent structure is key


On consistency inonline applications

“For every knob, button and widget on your computer screen, there’s a complex set of behaviours that we’ve become so accustomed to that we barely even notice them. It’s only when that consistency is gone, and we find ourselves clicking angrily at a scroll bar that’s not behaving like we expect it to, that we realize something’s amiss.”Ivor Tossell, “Think you know how to use a simple scroll bar? Think again.” The Globe and Mail, Friday, Oct. 12, 2007

writing reusable content

Technology