Writing for Reuse: Learning How To Write Modular Content for Reuse

Pamela KosturPartner

Parallax Communications

Writing for Reuse

© Parallax Communications 2008

Welcome

Issues with structure and inconsistent content


How to resolve issuesDefining structure, identifying reuse

Writing to the structure


Let’s think aboutreusable content

Should we reuse content?Why? Why not?How?What makes content reusable?


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


Discussion

What are your concerns about writing for reuse, or using content others have created?


Planning for reuse

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


Scenario

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


Your reuse plan

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


What is structure?

Refers to how information products are put togetherAlso refers to how content is written within that structureEnsures consistency whoever writes the information product or a part of it


What are content models?

Document the structure of your information products

The components they containHow components are structuredWhere components are used


Structure of info products

Follow a standard order:OverviewProduct featuresProduct specsInstallation procedures

Order depends on type of document


Structure and format

Structure and format are not the sameStructure refers to how info products and content are put togetherIdentical structures can have different formatsFormat refers to how content appears in its “published” form


Consistency is key

Similar types of information products should follow similar structuresSets user expectationsHelps them to find info more quicklyWhen structures differ:

Users have to relearnWriters have to create “on the fly”


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


My consistency pet peeve

Finding content in magazines!Why is this so hard?


I’m looking for pretty spring dresses in the TOC, but this article advertised on the cover is nowhere to be seen!


Some magazines have a different approach…


They identify cover stories in the TOC so you can find them.But, there’s still something wrong…


Some magazines are getting it right


Title on the cover differs from title here, but does it matter?


How to resolve?

Create a standard structure for that information typeIdentify where components are usedIdentify where content can be reusedSpecify how to write content


Differencesresolved through structure

Here’s what a structure for the magazine cover and TOC might look like:


Guidelines help even more

Writing for Reuse: Learning How To Write Modular Content for Reuse

Business

Transcript of Writing for Reuse: Learning How To Write Modular Content for Reuse