DevOps documentation: Manage documentation in a shared ownership environment
•Download as PPTX, PDF•
1 like•666 views
DevOps encapsulates the collaboration between Development and Operations teams to create, deliver and operate a product or service. But in such a collaborative structure, who is responsible for the documentation? Technical authors face a challenge when working with collaborative structures: knowledge is created in the team with the right specialty, not necessarily in the team which owns the document. As organisations seek to deliver products and services to market at an ever quicker pace, collaborative structures such as DevOps are becoming more common. To make the issue more challenging, these teams may be spread across different organisations and countries. I shall share doc-department’s experience working with DevOps organisation and how we overcame these challenges with an Open DevOps documentation approach that supports collaboration and communications across teams.
Recommended
More Related Content
Viewers also liked
Viewers also liked (7)
Similar to DevOps documentation: Manage documentation in a shared ownership environment
Similar to DevOps documentation: Manage documentation in a shared ownership environment (20)
Recently uploaded
Recently uploaded (20)
DevOps documentation: Manage documentation in a shared ownership environment
- 1. @docdepartment DevOps Documentation Managing documentation in a shared ownership environment
- 3. @docdepartment@docdepartment increase in revenue from product collaborations 15% www.atkearney.com/innovation/collaborative-innovation
- 5. @docdepartment@docdepartment find teammates who do something you can’t
- 7. @docdepartment@docdepartment “social” business uses social technology to foster collaboration IBMSocialStudy, 2014 74%
- 11. @docdepartment@docdepartment create and maintain documentation required by product or service produced as result of collaboration
- 12. @docdepartment@docdepartment material that provides official information or evidence, or material that serves as a record
- 14. @docdepartment@docdepartment content strategy content design process standards Information / content model style guide | DITA | DocBook CSS | template agile | waterfall | kanban PDF | xliff | SCORM
- 15. @docdepartment@docdepartment waterfall spiral v-shaped iterative open source Serial (>) Develop > Document > Translate Parallel ( ) Develop Document Translate Collective () Develop Document Translate Virtual Collaborative Writing in the Workplace, Hewett & Robidoux
- 16. @docdepartment@docdepartment monarchy hierarchy democracy consensus anarchy scale pace qual. Virtual Collaborative Writing in the Workplace, Hewett & Robidoux
- 17. @docdepartment@docdepartment content strategy content design process standards In. Ar TC SME > TC > UX UI > TC
- 18. @docdepartment@docdepartment collaboration between development and operations to create, deliver and operate a product or service Anne Gentle, 2009
- 19. @docdepartment@docdepartment 2 weeks 2 weeks Service Desk NOC Docs feedback@docs.com DevOps x x 2 weeks Development Operations
- 20. @docdepartment@docdepartment documentation as a conversation Anne Gentle, 2009
- 21. @docdepartment@docdepartment o framework o synchronous comms o transparent & open o collaborative
- 22. @docdepartment@docdepartment content strategy tools design process standards TC > TC PO TC TC Dev Ops
- 23. @docdepartment@docdepartment content troubleshooting product system arch. system design 3rd party Dev Ops TC Ops Dev Ops DevOps
- 24. @docdepartment@docdepartment Development Operations Service Desk NOC K’ Base DevOps 2 weeks documentation as a conversation
- 25. @docdepartment@docdepartment o deconstruct documentation o create framework o manage each piece appropriately
Editor's Notes
- This afternoon I’d like to share with you how doc-department have been able to achieve this by developing a complete product information solution using information that we learned from forums such as this conference, from the ISTC’s communicator magazine and from the wider technical communication community. With the additional capabilities that such a solution provides, we have been able to break out of the traditional tech comm boundaries and become an integral part of our client’s processes. In the first part of the talk I’ll share with you some of the information that helped doc-department lay the foundations of the solution. In the second part I’ll share some of the lessons we learned while deploying the solution. And to wrap up, I’d like to highlight some areas that doc-department can now support because we have a process that can consistently deliver quality content within our client’s 2 weekly agile cycle. Through the course of the talk I’ll also lay some common tech-comm myths to rest.
- Marketing communications We have all been told that Marketing departments are challenged to produce enough content. 2015 Benchmarks, Budgets, and Trends - Content Marketing Institute - http://contentmarketinginstitute.com/wp-content/uploads/2014/10/2015_B2B_Research.pdf
- Marketing communications We have all been told that Marketing departments are challenged to produce enough content. 2015 Benchmarks, Budgets, and Trends - Content Marketing Institute - http://contentmarketinginstitute.com/wp-content/uploads/2014/10/2015_B2B_Research.pdf
- Marketing communications We have all been told that Marketing departments are challenged to produce enough content. 2015 Benchmarks, Budgets, and Trends - Content Marketing Institute - http://contentmarketinginstitute.com/wp-content/uploads/2014/10/2015_B2B_Research.pdf
- Marketing communications We have all been told that Marketing departments are challenged to produce enough content. 2015 Benchmarks, Budgets, and Trends - Content Marketing Institute - http://contentmarketinginstitute.com/wp-content/uploads/2014/10/2015_B2B_Research.pdf
- And that content produced by technical communications is good for marketing So doc-department are currently working with Resilient’s Marketing team to provide them with content. We have refined our content model to ensure topics are aligned with marketing requirements so that marketing can reuse or refer to content in their campaigns For example, on-boarding or major releases. We are also looking and using the embedded content capability to deliver marketing messages directly in the UI. - IBM Technical Communications Body of Knowledge
- And that content produced by technical communications is good for marketing So doc-department are currently working with Resilient’s Marketing team to provide them with content. We have refined our content model to ensure topics are aligned with marketing requirements so that marketing can reuse or refer to content in their campaigns For example, on-boarding or major releases. We are also looking and using the embedded content capability to deliver marketing messages directly in the UI. - IBM Technical Communications Body of Knowledge
- Marketing communications We have all been told that Marketing departments are challenged to produce enough content. 2015 Benchmarks, Budgets, and Trends - Content Marketing Institute - http://contentmarketinginstitute.com/wp-content/uploads/2014/10/2015_B2B_Research.pdf
- … The challenge Why did we need to create such a product information solution in the first place? Our client Resilient plc provides a hosted telephony services call smartnumbers The services are accessed through a mobile app and desktop browsers. They have a 2 week development cycle Their application platform is deployed, monitored and supported by their operations team. Their customers are supported by Help Desk agents Customers have administrators who control the services for users in their organisation. As the services matures, it will be resold by channel partners, who will also provision and support their own customers. In addition, for compliance reasons, each release requires a set of PDF documentation to be achieved
- … The challenge Why did we need to create such a product information solution in the first place? Our client Resilient plc provides a hosted telephony services call smartnumbers The services are accessed through a mobile app and desktop browsers. They have a 2 week development cycle Their application platform is deployed, monitored and supported by their operations team. Their customers are supported by Help Desk agents Customers have administrators who control the services for users in their organisation. As the services matures, it will be resold by channel partners, who will also provision and support their own customers. In addition, for compliance reasons, each release requires a set of PDF documentation to be achieved