User Research in the Open-source Project: The Good Docs Project Case

This talk explores how The Good Docs Project integrated user research methodologies into an open-source environment to better understand our users and improve documentation templates and suite we provide. I'll share our journey of creating a UX research kit tailored for open-source projects, conducting user interviews, and analyzing qualitative data - all while navigating the unique challenges of distributed collaboration and volunteer contributors. This case study offers practical insights for other open-source communities looking to implement user-centered design approaches.

Resources:

Topics:

Beyond the Spec: Bringing Context to Life with GenAI for API Docs

API documentation is often limited to specs and references, but real-world usage and comprehension by various developer personas require more content types. This talk explores the critical conceptual topics — product overviews, tutorials, authentication, status codes, and best practices — that are often missing from auto-generated documentation.

Topics:

Beyond static docs: trends in documenting software solutions and their impact on the tooling

This talk will be from the perspective of JetBrains product developers, providing insights into how the documentation landscape is evolving, and showcasing innovative approaches that shape both the practice of documentation and the tools used to create and manage it.

Resources:

Topics:

Documentation Templates: A Helpful Aid or an Obstacle

Examining the role of documentation templates in open source projects - analyzing when they help streamline processes and when they become barriers to effective documentation.

Resources:

Topics:

Preparing internal knowledge for AI: Making content fit for LLMs and RAG, yet human-readable

Exploring how to structure internal knowledge to be both AI-friendly and human-readable, focusing on preparing content for Large Language Models and Retrieval-Augmented Generation systems.

Resources:

Topics:

Let's Bring Science Into API Documentation

Applying scientific methodologies and evidence-based approaches to API documentation practices to improve developer experience and documentation effectiveness.

Topics:

Using Domain-Specific Languages (DSLs) to Document API — the Kotlin DSL story

Exploring how Domain-Specific Languages can revolutionize API documentation through the lens of Kotlin DSL, demonstrating practical approaches to code-generated documentation.

Resources:

Topics:

Let's bring science into technical writing

Applying scientific principles and evidence-based methodologies to technical writing practices to create more effective and user-centered documentation.

Resources:

Topics:

Knowledge Management in Minimalist and How to Write Clear Technical Texts

Workshop covering minimalist approaches to knowledge management and techniques for writing clear, effective technical texts for team communication.

Resources:

Topics:

Knowledge Management for Internal Communications

Exploring effective knowledge management strategies for internal corporate communications and portal systems to improve organizational information flow.

Resources:

Topics:

У нас не будет альтернатив (There will be no alternatives)

Podcast episode discussing programming practices, technical decision-making, and the philosophy of software development alternatives.

Resources:

Topics:

Knowledge management

Podcast discussion about knowledge management practices, organizational learning, and strategies for effective knowledge sharing within technical teams.

Resources:

Topics:

How we tried to reconcile OpenAPI 3.0 and the custom DRF framework

Technical deep-dive into the challenges and solutions for integrating OpenAPI 3.0 specification with custom Django REST Framework implementations.

Resources:

Topics:

Confluence vs Sphinx: together or instead of?

This talk describes a real case on how we've integrated Sphinx and Confluence into a single documentation pipeline, and what were the pitfalls and gains from this approach.

Resources:

Topics:

Knowledge management with competence matrix

Exploring how competence matrices can be used as effective knowledge management tools to map team skills, identify knowledge gaps, and guide documentation efforts.

Resources:

Topics:

Competency matrix as a tool for team leads

Collaborative presentation with Konstantin Kaftan on using competency matrices as effective tools for team leads to assess, develop, and manage team skills and growth.

Resources:

Topics:

Confluence and collaborative documentation - opportunities and pitfalls

Analyzing the benefits and challenges of using Confluence for collaborative documentation, exploring best practices and common pitfalls in team-based documentation workflows.

Resources:

Topics: