cliffsnotes for documentation? absolutely! stc rochester - 2016 spectrum conference
TRANSCRIPT
![Page 1: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/1.jpg)
CliffsNotes® for Documentation?
Absolutely!
Todd DeLuca@TechCommTodd @STC_Rochester
#spectrum16
![Page 2: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/2.jpg)
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?
![Page 3: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/3.jpg)
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
![Page 4: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/4.jpg)
WHAT IS A ‘RELEASE’?
@STC_Rochester @TechCommTodd #spectrum16
![Page 5: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/5.jpg)
It’s Something New or Revised
• Hardware or Software• System or Platform• Book, journal,
magazine• Policy or Legal
Decision• Device or Gadget• App
![Page 6: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/6.jpg)
WHAT IS RELEASE DOCUMENTATION?
@STC_Rochester @TechCommTodd #spectrum16
![Page 7: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/7.jpg)
It’s a Summary or
List of Changes
• Overview• Highlights• Synopsis• Key Elements
![Page 8: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/8.jpg)
HOW IS IT LIKE CLIFFSNOTES®?
@STC_Rochester @TechCommTodd #spectrum16
![Page 9: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/9.jpg)
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
![Page 10: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/10.jpg)
Examples
• Release Notes• Summary• Overview• Grouped Content• New Features• Enhancements• Fixed ‘Bugs’ (…)
![Page 11: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/11.jpg)
![Page 12: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/12.jpg)
![Page 13: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/13.jpg)
WHY IS IT USEFUL?
@STC_Rochester @TechCommTodd #spectrum16
![Page 14: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/14.jpg)
They Serve a Need and Variety of Audiences
• Where Most People Start• Great for Busy People• Leaves First Impression• Different Uses• Different Content Types• Used by Multiple Groups
![Page 15: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/15.jpg)
WHY SHOULD I CARE?
@STC_Rochester @TechCommTodd #spectrum16
![Page 16: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/16.jpg)
They Are an Opportunity
• Relatively Easy to Produce• Cost Effective• Already Have the Skills• Simple to Assemble• Something Else to
Deliver• Provides Value
![Page 17: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/17.jpg)
Other Benefits
• Bigger Audience• Connect with Others• Future Looking• Future Proof• Regular Deliverable
![Page 18: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/18.jpg)
Increase Your Value
• Add to Your Toolkit• Offer as a Service• Help Others Share
![Page 19: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/19.jpg)
TIPS & THINGS TO CONSIDER
@STC_Rochester @TechCommTodd #spectrum16
![Page 20: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/20.jpg)
ProcessConsideration
s• Understand Limitations• Plan for the Time• Know the Schedule• Solicit Contributions• Get Review (QA)• Determine Delivery
Vehicle• Publish & Promote• Gather Feedback
![Page 21: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/21.jpg)
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
![Page 22: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/22.jpg)
Content Tips• Be Specific• Use Appropriate Tone• Avoid Vague Entries• Bug Fixes• Performance
Enhancements• For Issues (Bugs)• Include Scenario• Consider Testing
![Page 23: CliffsNotes for Documentation? Absolutely! STC Rochester - 2016 Spectrum Conference](https://reader035.vdocuments.site/reader035/viewer/2022062902/58ede6e71a28abbc5c8b45cb/html5/thumbnails/23.jpg)
QUESTIONS?
What do you think?
@STC_Rochester @TechCommTodd #spectrum16