Open Source Summit Europe 2024

In the realm of open source development, efficient and comprehensive documentation plays a pivotal role in facilitating collaboration, adoption, and innovation. However, creating high-quality documentation often proves time-consuming and labor-intensive for developers. In this session, we will explore the potential of using large language models (LLMs) in automating documentation creation, streamlining the documentation workflow and enhancing the overall developer experience. We will delve into the intricacies of integrating generative AI models into the documentation workflow, discussing key aspects such as open source tooling for model development, model selection and effective evaluation of the generated documentations. Attendees will gain insights into how generative AI can revolutionize the way documentation is created and maintained in open source projects, ultimately driving greater efficiency and productivity in software development workflows. This talk is a must for anyone looking to transform their documentation from a laborious manual process to an efficient automated one, ushering in a new generation of streamlined documentation workflows.

Documentation templates serve as indispensable tools in the technical writing arsenal, offering a structured framework to streamline communication, ensure consistency, and distribute best practices. This talk delves into the intricate balance between harnessing the benefits of templates while navigating potential pitfalls, offering insights from my participation in The Good Docs project.

In today's interconnected world, open source thrives on collaboration, yet language barriers in documentation impede knowledge exchange. As languages like Chinese and Japanese gain prominence, native speakers play increasingly vital roles. Yet, the lack of universal understanding necessitates a two-step localization process, from the source language to English and then to local languages. Amidst this backdrop, in OpenAtom openEuler, a pioneering project born in China which has been spearheading internationalization efforts, we initiated G11N SIG, an instrumental globalization group in tackling these challenges head-on. As a maintainer of G11N and a social media operator who is deeply attuned to localization challenges, I bring firsthand experience and expertise to the table. In this session, we'll embark on a comprehensive exploration of openEuler's journey, delving into successful strategies, encountered challenges, and the lessons learned in surmounting language barriers. We'll shed light on AI's assistance in localization efforts and the empowering potential of social media in enhancing accessibility.

The Google Season of Docs program gives direct grants to open source projects to hire technical writers. The technical writing projects supported by these grants are intended to solve real problems for open source project communities, and the case studies created by the projects are intended to help other open source projects learn how to conceptualize and create their own problem-solving open source documentation. In this talk, we'll walk through how projects participating in Google's Season of Docs program have framed their problems, hypothesized solutions, created documentation to solve those problems, and measured the success of their documentation.

Have you ever had the need to show a live version of what your technical documentation is presenting? Don't you agree that seeing things in action is the best way to convey your documentation goals? Have you ever had to deal with the complexity of the learners' heterogeneous environments? Or in other words, have the learners of your product wanted to learn how your project works but some have windows, some linux others mac, some constrained laptops, some don't have enough memory? For this problem online playgrounds for hands-on learning that help you deliver a hands-on experience via a web browser is the best way to go. But many of these do cost a lot of money, while this runs on containers on a simple Kubernetes cluster. In this workshop, we will demonstrate Educates, an open source hands-on workshop platform that can help you deliver hands-on learning experience as well as workshops and demos, in a very easy, reproducible and cost effective way. And we will be using an Educates workshop, which means Inception. This technology is the one used by VMware's Spring.Academy, Tanzu.Academy and Kube.Academy. I encourage you to spend this short time with us. It'll change your life.