Scaling OSS Documentation with AI

A session diving into how I utilized AI to streamline and automate the documentation process

Transcript

2. Twitter: @bethanyjep Scaling Open-Source documentation with AI
3. Twitter: @bethanyjep Bethany, Jepchumba Cloud Advocate, Microsoft Scaling Open-Source documentation with AI
4. Agenda LLMs as a Service Agents as a Service Scalability as a Service
5. What’s harder; writing great code, or writing great documentation?
6. Goal Clear, accurate, and up-to-date documentation struggles maintaining robust documentation at scale is often resource-intensive, manual, and challenging
7. Where does AI come in?
9. LLMs as a Service
10. Scenario A ton of empty doc pages with some understanding of the codebase, how could we make it to 100%
11. Goal Clear, accurate, and up-to-date documentation struggles One maintainer Widely used across presentations Not enough technical depth on the project
12. Prompty a language agnostic asset class for creating prompts and managing the responses. https://aka.ms/prompty
13. Agents as a Service
14. Scenario Docs are now complete; how do we streamline management of the repo?
15. Goal Streamlined and well-maintained repo management workflow struggles One maintainer Widely used across presentations Not enough technical depth on the project
18. Scalability as a Service
19. Scenario Okay, what about scale? How do we ensure the docs are reusable by our audience?
20. Goal Localized and accessible docs struggles Over 15k downloads Used globally by people from all over the globe.
21. automate translating Markdown files and images containing embedded text into multiple languages https://github.com/Azure/co-op-translator
22. THANK YOU! @bethanyjep
23. THANK YOU! Twitter: @bethanyjep
24. Colours Typography #04FF00 #8C5BFE #FFDA00 #FF0000 #FF9D00 Google Sans #FFFFFF #1E1E1E