cliffs notes for documentation? absolutely! stc new england - interchange 2016

CliffsNotes® for Documentation?

Absolutely!

Todd DeLuca@TechCommTodd@STCNewEnglan

d#techcomm

WHAT ARE WE TALKING ABOUT?

•What is a release?•What is release documentation?•How is it like CliffsNotes®?•Why is it useful?•Why should I care?• Tips and things to consider•Questions?

Who am I?

• Tech Comm Manager(Black Knight Financial Services)• STC Associate Fellow• STC Community

Leader• STC Summit Chair• Presenter & Speaker• My story…

Todd DeLuca@TechCommTodd

WHAT IS A ‘RELEASE’?

@STCNewEngland @TechCommTodd #techcomm

It’s Something New or Revised

• Hardware or Software• System or Platform• Book, journal,

magazine• Policy or Legal

Decision• Device or Gadget• App

WHAT IS RELEASE DOCUMENTATION?

@STCNewEngland @TechCommTodd #techcomm

It’s a Summary or

List of Changes

• Overview• Highlights• Synopsis• Key Elements

HOW IS IT LIKE CLIFFSNOTES®?

@STCNewEngland @TechCommTodd #techcomm

They capture the ’essence’ of what’s released

• Condenses Content• Tells Major Story• Highlights Main

Points• Covers Plot

Elements• Paints the Big

Picture• Shows Samples

Examples

• Condenses Content• Tells Major Story• Highlights Main

Points• Covers Plot

Elements• Paints the Big

Picture• Shows Samples

WHY IS IT USEFUL?

@STCNewEngland @TechCommTodd #techcomm

They Serve a Need and Variety of Audiences

• Where Most People Start• Great for Busy People• Leaves First Impression• Different Uses• Used by Multiple Groups• Serves Different

Audiences

WHY SHOULD I CARE?

@STCNewEngland @TechCommTodd #techcomm

They Are an Opportunity

• Relatively Easy to Produce• Cost Effective• Already Have the Skills• Simple to Assemble• Something Else to

Deliver• Provides Value

Other Benefits

• Bigger Audience• Connect with Others• Future Looking• Future Proof• Regular Deliverable

Increase Your Value

• Add to Your Toolkit• Offer as a Service• Help Others Share

TIPS & THINGS TO CONSIDER

@STCNewEngland @TechCommTodd #techcomm

ProcessConsideration

s• Understand Limitations• Plan for the Time• Know the Schedule• Solicit Contributions• Get Review (QA)• Determine Delivery

Vehicle• Publish & Promote• Gather Feedback

Production Tips

• Start Slow & Expand Later• Keep it Simple• Make it Consistent• Produce Regularly• Leverage Current

Content• Use Existing Tools• Link to other Resources• Consider Images

Content Tips• Be Specific• Use Appropriate Tone• Avoid Vague Entries• Bug Fixes• Performance

Enhancements• For Issues (Bugs)• Include Scenario• Consider Testing

QUESTIONS?

What do you think?

@STCNewEngland @TechCommTodd #techcomm

THANK YOU!Keep in Touch

• LinkedIn: techcommtodd• Twitter: @techcommtodd• Mail: techcommtodd@gmail.com