Overview
Learn how to foster a culture of documentation within your organization in this 26-minute conference talk. Explore the importance of well-documented projects, understand what constitutes good and bad documentation, and discover strategies to overcome common obstacles. Gain insights into integrating documentation processes into existing workflows, convincing stakeholders of its value, and elevating documentation to its rightful place alongside code. Examine a case study from a Fortune 500 company and acquire practical tools and techniques to standardize and improve documentation practices. By the end of this talk, be equipped to transform your team's approach to documentation, ensuring project success and usability.
Syllabus
Intro
WHAT IS DOCUMENTATION? (WHAT DOES IT DO?)
WHY IS GOOD DOCUMENTATION IMPORTANT?
WHAT MAKES GOOD DOES?
WHAT MAKES BAD DOCS?
WHAT LEADS TO DOC FAILURE?
WHAT ARE THE CONSEQUENCES OF BAD DOCS?
CHANGING YOUR CULTURE
START FROM THE TOP
CHOOSE SOMEONE TO DRIVE IT
MAKE IT EASY
START WITH STANDARDIZATION
DOCUMENTATION TOOLS
CASE STUDY-FORTUNE 500 COMPANY
Taught by
CNCF [Cloud Native Computing Foundation]