From Documentation to Content Strategy: A Case Study

28
Ray Gallon CULTURECOM CULTURE COMMUNICATION TECHNOLOGIE

description

How a call for documentation can expand to include many different activities, illustrated with work in progress - presented at Localization World, Paris - TEKOM track, 5 June 2012.

Transcript of From Documentation to Content Strategy: A Case Study

Page 1: From Documentation to Content Strategy: A Case Study

Ray Gallon

CULTURECOM CULTURE COMMUNICATION TECHNOLOGIE

Page 2: From Documentation to Content Strategy: A Case Study

The Call:

Page 3: From Documentation to Content Strategy: A Case Study

The Product � Business Activity Monitoring (BAM)

software �  Fits the space between Business Process

Management (BPM) and Business Intelligence (BI).

� Client describes two audiences:

�  IT

� Management

Page 4: From Documentation to Content Strategy: A Case Study

The Two Audiences

�  IT: �  Interested in technical integrity of

process

�  Interested in QA per existing SLA

(internal or external)

� Concern that the application not

damage their infrastructure

�  Management: �  Interested in strategic and operational data that can be extracted from the processes

�  Don’t have great desire to use the software “hands on.”

Page 5: From Documentation to Content Strategy: A Case Study

The Discovery Process

� Expressed need:

� “Documentation” – not

described in any detail

� Objective: make the software

easier to understand for

potential customers.

Page 6: From Documentation to Content Strategy: A Case Study

The Discovery Process

�  Interviews with key players reveal the following non expressed needs: �  A documentation philosophy � Content architecture � Help with a content strategy for the two audiences

� Help with interaction design choices

Page 7: From Documentation to Content Strategy: A Case Study

The Discovery Process

�  Interviews with key players reveal the following non expressed needs: �  A documentation philosophy � Content architecture � Help with a content strategy for the two audiences

� Help with interaction design choices

content strategy

Page 8: From Documentation to Content Strategy: A Case Study

The Two Audiences: Subtext

COMMUNICATIONS CHANNEL

INTERACTION

I YOU

Page 9: From Documentation to Content Strategy: A Case Study

The Two Audiences: Subtext

COMMUNICATIONS CHANNEL

INTERACTION

I SOFTWARE

Page 10: From Documentation to Content Strategy: A Case Study

Example: Business Process Dashboard – Order Fulfillment

User Interaction model: Progressive Disclosure

Page 11: From Documentation to Content Strategy: A Case Study

Key Recommendations After Discovery �  “Documentation” = Embedded, on line, progressively

disclosed assistance, including decision support

�  Combination of standardized OLH plus customized material: �  Done by the co. as part of a service contract �  Custom annotations by end user

�  Software must communicate with two voices to the two audiences

�  Use DITA to maximise reuse, conditional text, etc.

�  No CMS – Use existing configuration management system for content management, but prepared for eventual migration

Page 12: From Documentation to Content Strategy: A Case Study

� There are indeed, two audiences,

but IT isn’t one of them.

� The real two audiences are: � Operational people � Strategy people

Page 13: From Documentation to Content Strategy: A Case Study

In an Ideal World… �  There would be personas

or user profiles before

development begins

�  These profiles would then be applied to

the content creation process: �  Interaction design �  Interface graphics �  User assistance

� Prototypes would be tested with real

users or potential users

Page 14: From Documentation to Content Strategy: A Case Study

How It Really Happened �  Product was designed with certain

preconceived notions of user profiles, never researched

�  Content, tone, etc. not taken into account at all

�  Real user research considered “too difficult because there are no users – it’s a new product”

�  Some of this work now being done, in parallel with content development

Page 15: From Documentation to Content Strategy: A Case Study

Chosen Architecture: Progressive Disclosure

No

Yes Link

Multiple Links

At Will

Page 16: From Documentation to Content Strategy: A Case Study

Adaptation of Process to Reality

Project phase one:

Start content development of “standard”

mode UA (tool tips, tasks, etc.) –

common trunk, user functions only

Page 17: From Documentation to Content Strategy: A Case Study

Adaptation of Process to Reality

In parallel, in phase one:

Interview potential users, develop proper

user profiles

Start differentiating tone and voice for

different audiences

Adjust UI for consistency, better

ergonomics, target users

Page 18: From Documentation to Content Strategy: A Case Study

Work in progress

Page 19: From Documentation to Content Strategy: A Case Study

Click here to reveal detailed

information

Progressive Disclosure User Interface

Page 20: From Documentation to Content Strategy: A Case Study

Result: a “Portlet” You can drill down further to see individual transactions

Double click a line for drill

down

Page 21: From Documentation to Content Strategy: A Case Study

User Assistance Progressive Disclosure Model

Enhanced tool tip is first level of disclosure

Click here for more help

Page 22: From Documentation to Content Strategy: A Case Study

User Assistance Progressive Disclosure Model

Enhanced tool tip is first level of disclosure

Click here for more help

Click here for a full concept

Page 23: From Documentation to Content Strategy: A Case Study

The Concept Pane Opens

Page 24: From Documentation to Content Strategy: A Case Study

The Concept Pane Opens Click here to

open the TOC

Links to more information at

bottom of pane

Page 25: From Documentation to Content Strategy: A Case Study
Page 26: From Documentation to Content Strategy: A Case Study

Adaptation of Process to Reality

� Planned Phase Two: �  Find a technical writer to maintain standard

content �  Expand “standard” UA to include

administrative functions �  Adjust UA content and style rules based on

user testing � Develop input application for SME’s, in-

house consultants � Develop applet to permit user annotation

Page 27: From Documentation to Content Strategy: A Case Study

In Summary: �  “Help, we need documentation” becomes a

call for: �  Content strategy – voices, user profiling �  UX – user profiling, testing, refining interaction

design, interaction design of UA �  Document Content Architecture – choice of

system, content management strategy �  Information Architecture – structure of the UA

content �  Content development – otherwise known as

writing

Page 28: From Documentation to Content Strategy: A Case Study

email: [email protected]

Please check out my blog, « Rant of a Humanist Nerd: »

http://humanistnerd.culturecom.net

Twitter: @raygallon LinkedIn and Google+: Ray Gallon

CULTURECOM CULTURE COMMUNICATION TECHNOLOGIE

Member, board of directors