Download to read offline
Uploaded byArnab Sinha
In-line code documentation
Ignite Talk @ DevOps Days Amsterdam, 2017 In the world of Agility, Continuous Delivery and DevOps way of working, we write a lot of code, release it frequently and support it. Smarter ways of documentation have evolved, like Wiki's, tags etc which enables minimal documentation and collaboration between Dev & Ops. When a bolt strikes out of the blue on the production systems and the issue needs to be resolved, the MTTR's are high even though its a DevOps team. A pareto analysis reveals time to reach the right documentation for analysis and additional information required for debugging and resolution are key areas. In enterprises, people are always on the move from projects to projects/domains/other companies. Thus, its quintessential that we have in-line adequate documentation with appropriate maturity. Let's have a look how can this be implemented in the DevOps way of working! Link to DevOps Days Amsterdam, 2017: https://www.devopsdays.org/events/2017-amsterdam/program/ About the speaker: https://www.devopsdays.org/events/2017-amsterdam/speakers/arnab-sinha/ GitHub DevOpsDays Demo (IgniteTalk –In-line code documentation): https://github.com/arnabsinha4u/in-line-code-documentation-demo
In-line code documentation
- 1. DevOpsDays Amsterdam 28th-30th June,2017 In-line <code> documentation Arnab Sinha
- 2.
- 3.
- 4.
- 5.
- 6.
- 7.
- 8. DevOps customerjourney Code vs DocumentationRatio Quality & Coverage of Documentation
- 9. Complexityexample Fibonacci Numbers without Recursion Towerof Hanoi without Recursion Tower of Hanoi with Recursion Fibonacci Numbers with Recursion
- 10. Complexityexample Fibonacci Numbers without Recursion Towerof Hanoi without Recursion Tower of Hanoi with Recursion Fibonacci Numbers with Recursion
- 11.
- 12.
- 13.
- 14.
- 15.
- 16.
- 17.
- 18.
- 19.
- 20. Wheretofind…? GitHub: https://github.com/arnabsinha4u/ GitHub DevOpsDays Demo (Ignite Talk – In-line code documentation): https://github.com/arnabsinha4u/in-line-code-documentation-demo Branches: master doc_improvement_1 doc_improvement_2 doc_improvement_3 GitHub DevOps Days Demo (Workshop): https://github.com/arnabsinha4u/ansible-traininglab arnabsinha4u@gmail.com Arnab Sinha