writing reusable content to support content models
TRANSCRIPT
Pamela KosturPartner
Parallax Communications
Writing Reusable Content to Support Models
© Parallax Communications 2008
Welcome
Issues with structure
© Parallax Communications 2008
How to resolve issuesDefining structure, identifying reuse
Writing to the structure
© Parallax Communications 2008
What are content models?
Document the structure of your information products
The components they containHow components are structuredWhere components are used
© Parallax Communications 2008
What is structure?
Shows 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
© Parallax Communications 2008
Structure of info products
Follow a standard order:OverviewProduct featuresProduct specsInstallation procedures
Order depends on type of document
© Parallax Communications 2008
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”
© Parallax Communications 2008
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
© Parallax Communications 2008
My consistency pet peeve
Finding content in magazines!Why is this so hard?
© Parallax Communications 2008
I’m looking for pretty spring dresses in the TOC, but this article advertised on the cover is nowhere to be seen!
© Parallax Communications 2008
Some magazines have a different approach…
© Parallax Communications 2008
They identify cover stories in the TOC so you can find them.But, there’s still something wrong…
© Parallax Communications 2008
© Parallax Communications 2008
Some magazines are getting it right
© Parallax Communications 2008
Title on the cover differs from title here, but does it matter?
© Parallax Communications 2008
How to resolve?
Create a standard structure for that information typeIdentify where components are usedIdentify where content can be reusedSpecify how to write content
© Parallax Communications 2008
Differencesresolved through structure
Here’s what a structure for the magazine cover and TOC might look like:
© Parallax Communications 2008
Guidelines help even more
© Parallax Communications 2008
How does structure helpto write reusable content?
It tells you what an information product containsIt tells you where components are usedIt tells you how to write components consistentlyIt increases usability
Unstructured content is difficult for readers to follow and for authors to create and reuse
© Parallax Communications 2008
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
© Parallax Communications 2008
Writing to a structure
Think of your structure as an outlineThe structure tells you what you need to includeBut, you still have to put content into it
© Parallax Communications 2008
Creating writing guidelines
Writing guidelines support structureProvide further assistance to writersTell them specifically how to write a piece of contentWriting guidelines help to make content reusable
© Parallax Communications 2008
Reusable content?
© Parallax Communications 2008
What about this?
© Parallax Communications 2008
© Parallax Communications 2008
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
© Parallax Communications 2008
Sample structure
© Parallax Communications 2008
Another way ofshowing structure
© Parallax Communications 2008
Content reuse and usability
Reusing content alone doesn’t ensure usabilityReusing unusable content makes it consistently unusableNeed to determine what is usable and base standards on that
© Parallax Communications 2008
Common understanding
Having a common understanding of the standards is criticalAll writers need to understand such things as:
How much information to includeHow are procedures structuredWhat terminology is appropriate
© Parallax Communications 2008
Reuse and Web 2.0
In Web 2.0, apparently the user rules:User-generated contentBlogs, wikis, social networking sites
Users generate and distribute content, often with a view to reuse and shareThis is great, but…
© Parallax Communications 2008
Is reuse always OK?
There’s lots of bad content out thereIn social networking, can’t always control how your content is usedBut, even if you can’t control what people do with your content, you can:
Make your reuse strategy solidBase your content on standards
© Parallax Communications 2008
Summary
Models define structureWriting guidelines tell authors how to write to the structureReusable content is based on standards that all writers followCommon understanding is criticalReusable content must be usable content
© Parallax Communications 2008
For more information
Contact us at Parallax CommunicationsPamela Kostur
Download slides at www.parallax.ca