Moving the organization_apr2012

29
Moving the Organization to Collaborative or Structured Authoring Larry Kunz @larry_kunz 25 April 2012

description

Moving the Organization to Collaborative or Structured AuthoringAudience: Project managers and other technical communicatorsPresented 25 April 2012 as part of STC webinar seriesOutline:- What is collaborative or structured authoring?- The steps for planning and executing the transition from traditional authoring- Putting it all into perspective

Transcript of Moving the organization_apr2012

Page 1: Moving the organization_apr2012

Moving the Organizationto Collaborative

or Structured Authoring

Larry Kunz@larry_kunz

25 April 2012

Page 2: Moving the organization_apr2012

About me

• 30+ years in Tech Comm• Writer, architect, manager• STC Fellow

#movetostructured@larry_kunz

Page 3: Moving the organization_apr2012

Outline

• What do I mean by collaborative or structured authoring?

• Moving the organization (stages)• Putting it all together

#movetostructured@larry_kunz

Page 4: Moving the organization_apr2012

Structured authoring

Principle 1: Collaboration• You’ll work on pieces instead of whole

documents.• Multiple writers work together on the same

sections (chapters or appendixes).

#movetostructured@larry_kunz

Page 5: Moving the organization_apr2012

Structured authoring

Principle 2: Elements and attributes• Content has associated semantic

elements and attributes.• Styles are applied when the content is

published.

#movetostructured@larry_kunz

Page 6: Moving the organization_apr2012

Structured authoring

Principle 3: Reuse• Develop information once and use it in

multiple places• Topic- or element-level• Benefits: efficiency and consistency• Sometimes called single-sourcing

#movetostructured@larry_kunz

Page 7: Moving the organization_apr2012

Structured authoring

The business case• Cost savings through:

–Efficiency–Single-sourcing–Lower translation costs–Automated publishing process

#movetostructured@larry_kunz

Page 8: Moving the organization_apr2012

Structured authoring

The business case• Customer satisfaction through:

– Greater number of output formats– More nimble publishing process– Community-generated content

#movetostructured@larry_kunz

Page 9: Moving the organization_apr2012

Structured authoring

What it means to the writers• Probably new tools• The business case• Collaboration• Topics, not books• Different ownership model

#movetostructured@larry_kunz

Page 10: Moving the organization_apr2012

Methodologies for structured authoring

Two examples

• DITA http://dita.xml.org/

• S1000D http://www.s1000d.org/

#movetostructured@larry_kunz

Page 11: Moving the organization_apr2012

How do I move the organization?

1. Evaluate

2. Architect

3. Refine processes

4. Train

5. Roll out

6. Assess

7. Adjust

#movetostructured@larry_kunz

Page 12: Moving the organization_apr2012

Evaluate

• Future needs/business objectives• Needs of the audience• The financial landscape• Skills you have in-house

#movetostructured@larry_kunz

Page 13: Moving the organization_apr2012

Evaluate

• Current content• Current workflow• Current information flow• Current pains

#movetostructured@larry_kunz

Page 14: Moving the organization_apr2012

Architect

Is there a content strategy?• If so, align with it• If not, collaborative/structured authoring

makes it easier to devise one

#movetostructured@larry_kunz

Page 15: Moving the organization_apr2012

Architect

Architect for:• Topic structure• Relationships among topics• Reuse• Expected publishing formats• Content management

#movetostructured@larry_kunz

Page 16: Moving the organization_apr2012

Refine processes

• Planning• Authoring• Editing• Reviewing• Approving• Translating• Publishing

#movetostructured@larry_kunz

Page 17: Moving the organization_apr2012

Refine processes

• Find the gap between existing and ideal• Prioritize (pick your battles)• Ensure new processes allow for

collaborative, topic-based writing• Get buy in for all changes from all

stakeholders• Align new processes with current workflow

#movetostructured@larry_kunz

Page 18: Moving the organization_apr2012

Refine processes

• Have an implementationroadmap

• Communicate the roadmapto all stakeholders

#movetostructured@larry_kunz

Page 19: Moving the organization_apr2012

Refine processes

Reviews and approvals:• Not too rigorous, not too light• Must meet legal and regulatory

requirements• Use the software

#movetostructured@larry_kunz

Page 20: Moving the organization_apr2012

Refine processes

• Pick the right tools for the job• One size does not fit all• Consider:

–The current environment–How the tools work together–The workflow you’ve developed

#movetostructured@larry_kunz

Page 21: Moving the organization_apr2012

Train

Training is indispensible!

#movetostructured@larry_kunz

Page 22: Moving the organization_apr2012

Train

• Tailor to each set of stakeholders• Like a marketing campaign• Don’t rush it

#movetostructured@larry_kunz

Illustration: www.startwithwhy.com

Page 23: Moving the organization_apr2012

Train

For the writing team:• Structured authoring fundamentals• Practical, hands-on training• Soon enough, but not too soon

For the technical staff:• Description of XSLTs, schemas

For SMEs and reviewers:• Processes & tools for reviews/approvals

#movetostructured@larry_kunz

Page 24: Moving the organization_apr2012

Roll out

• Time it to align with project schedules• Pilot projects are ideal

#movetostructured@larry_kunz

Page 25: Moving the organization_apr2012

Assess

• Be sensitive to the mood• Relax: You won’t get everything right the

first time

#movetostructured@larry_kunz

Page 26: Moving the organization_apr2012

Adjust

• Have a Plan B in your desk drawer• Fall back to the old way• Leave some processes alone for now• Recalibrate and try again

I am not discouraged, because every wrong attempt discarded is another step forward.

- Thomas Edison

#movetostructured@larry_kunz

Page 27: Moving the organization_apr2012

Putting it All Together

#movetostructured@larry_kunz

Evaluate

Architect

Refine processes

TrainRoll out

Assess

Adjust

Page 28: Moving the organization_apr2012

Putting it All Together

It doesn’t all happen overnight• Set a realistic timeline• Manage expectations• Monitor and assess constantly

Don’t be deterred by failure

DIY or hire a consultant?

#movetostructured@larry_kunz

Page 29: Moving the organization_apr2012

Q&A

#movetostructured@larry_kunz