Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Cliffs Notes for Documentation? Absolutely! STC New England - Interchange 2016

363 views

Published on

Presentation presented to STC New England chapter in Lowell, Massachusetts (MA) on April 1, 2016. Talks about benefits and future of short format and release documentation (commonly release notes)

  • Be the first to comment

Cliffs Notes for Documentation? Absolutely! STC New England - Interchange 2016

  1. 1. CliffsNotes® for Documentation? Absolutely! Todd DeLuca @TechCommTodd @STCNewEngland #techcomm
  2. 2. 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?
  3. 3. 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
  4. 4. WHAT IS A ‘RELEASE’? @STCNewEngland @TechCommTodd #techcomm
  5. 5. It’s Something New or Revised • Hardware or Software • System or Platform • Book, journal, magazine • Policy or Legal Decision • Device or Gadget • App
  6. 6. WHAT IS RELEASE DOCUMENTATION? @STCNewEngland @TechCommTodd #techcomm
  7. 7. It’s a Summary or List of Changes • Overview • Highlights • Synopsis • Key Elements
  8. 8. HOW IS IT LIKE CLIFFSNOTES®? @STCNewEngland @TechCommTodd #techcomm
  9. 9. 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
  10. 10. Examples • Condenses Content • Tells Major Story • Highlights Main Points • Covers Plot Elements • Paints the Big Picture • Shows Samples
  11. 11. WHY IS IT USEFUL? @STCNewEngland @TechCommTodd #techcomm
  12. 12. 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
  13. 13. WHY SHOULD I CARE? @STCNewEngland @TechCommTodd #techcomm
  14. 14. They Are an Opportunity • Relatively Easy to Produce • Cost Effective • Already Have the Skills • Simple to Assemble • Something Else to Deliver • Provides Value
  15. 15. Other Benefits • Bigger Audience • Connect with Others • Future Looking • Future Proof • Regular Deliverable
  16. 16. Increase Your Value • Add to Your Toolkit • Offer as a Service • Help Others Share
  17. 17. TIPS & THINGS TO CONSIDER @STCNewEngland @TechCommTodd #techcomm
  18. 18. Process Considerations • Understand Limitations • Plan for the Time • Know the Schedule • Solicit Contributions • Get Review (QA) • Determine Delivery Vehicle • Publish & Promote • Gather Feedback
  19. 19. 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
  20. 20. Content Tips • Be Specific • Use Appropriate Tone • Avoid Vague Entries • Bug Fixes • Performance Enhancements • For Issues (Bugs) • Include Scenario • Consider Testing
  21. 21. QUESTIONS? What do you think? @STCNewEngland @TechCommTodd #techcomm
  22. 22. THANK YOU! Keep in Touch • LinkedIn: techcommtodd • Twitter: @techcommtodd • Mail: techcommtodd@gmail.com

×