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.
Delivering High-Velocity Docs that
Keep Pace with Rapid Release Cycles
Write the Docs EU 2016
@rachwhitton
@rachwhitton
● Support background in web services
● Began working on docs as a side project
● Self-learning developer
● Jo...
Docs or it didn’t
happen!
@rachwhitton
Requiring docs within releases
@rachwhitton
Reality check
Docs won’t block releases until
trust in delivery is established.
Releasing software should be easy. It
should be easy because you have tested
every single part of the process hundreds
of ...
@rachwhitton
Docs must meet the same
standards of reliability and
repeatability before they can be
enforced as a part of t...
@rachwhitton
The Big Picture
Milestones for Delivering High-Velocity Docs
Increase Project Visibility
Simplify Peer Review...
@rachwhitton
Increase Project Visibility
@rachwhitton
Centralized Workflow
Collaborate across teams.
Work multiple issues simultaneously without
blocking deploymen...
@rachwhitton
Allow public contributions and document upcoming
features in the open.
Open Source
@rachwhitton
Integrate services such as GitHub within communication
tools like Slack.
Dependable Notifications
@rachwhitton
Simplify Peer Reviews
@rachwhitton
Make Success Easy
Prioritize the contributor experience of all roles and make
improvements iteratively. Focus...
@rachwhitton
Automate Grunt Work
Building and publishing content must be a repeatable and reliable
process - started with ...
@rachwhitton
Automation
@rachwhitton
Bots Handle the Grunt Work
Automated Deployment Pipeline
Stage content on isolated environments w/public URLs...
@rachwhitton
Bells and Whistles
@rachwhitton
Next Steps
Continuous integration for docs isn’t the end of the road - it’s an
essential tool for building tr...
Upcoming SlideShare
Loading in …5
×

Delivering High-Velocity Docs that Keep Pace with Rapid Release Cycles

508 views

Published on

Write the Docs EU 2016

Published in: Technology
  • Be the first to comment

Delivering High-Velocity Docs that Keep Pace with Rapid Release Cycles

  1. 1. Delivering High-Velocity Docs that Keep Pace with Rapid Release Cycles Write the Docs EU 2016 @rachwhitton
  2. 2. @rachwhitton ● Support background in web services ● Began working on docs as a side project ● Self-learning developer ● Joined Pantheon in 2014 ● Automation and workflow enthusiast About Me
  3. 3. Docs or it didn’t happen!
  4. 4. @rachwhitton Requiring docs within releases
  5. 5. @rachwhitton Reality check Docs won’t block releases until trust in delivery is established.
  6. 6. Releasing software should be easy. It should be easy because you have tested every single part of the process hundreds of times before. It should be as simple as pressing a button. — David Farley Continuous Delivery: Reliable Software Releases through Build, Test, and Deployment Automation
  7. 7. @rachwhitton Docs must meet the same standards of reliability and repeatability before they can be enforced as a part of the release cycle. Establishing Trust
  8. 8. @rachwhitton The Big Picture Milestones for Delivering High-Velocity Docs Increase Project Visibility Simplify Peer Reviews Automate Grunt Work 1 2 3
  9. 9. @rachwhitton Increase Project Visibility
  10. 10. @rachwhitton Centralized Workflow Collaborate across teams. Work multiple issues simultaneously without blocking deployments. Track issues and progress from a central location.
  11. 11. @rachwhitton Allow public contributions and document upcoming features in the open. Open Source
  12. 12. @rachwhitton Integrate services such as GitHub within communication tools like Slack. Dependable Notifications
  13. 13. @rachwhitton Simplify Peer Reviews
  14. 14. @rachwhitton Make Success Easy Prioritize the contributor experience of all roles and make improvements iteratively. Focus efforts on paths most traveled. Simplify Peer Reviews
  15. 15. @rachwhitton Automate Grunt Work Building and publishing content must be a repeatable and reliable process - started with the click of a button
  16. 16. @rachwhitton Automation
  17. 17. @rachwhitton Bots Handle the Grunt Work Automated Deployment Pipeline Stage content on isolated environments w/public URLs automatically. Deploy to production with a single click. Establish Trust with Automated Tests No more surprises.
  18. 18. @rachwhitton Bells and Whistles
  19. 19. @rachwhitton Next Steps Continuous integration for docs isn’t the end of the road - it’s an essential tool for building trust. For docs to truly become an enforced requirement of the release cycle, it needs buy in from everyone.

×