← Volver a NERDflix

Creating documentation that developers will actually read

Protagonista: Damilola Ezekiel
Año: 2025
País: España
Género: Documental
Track: Open Source
Idioma: Inglés

When in doubt, read the docs. When deployment breaks, read the docs. When everything’s fine and you’re just vibe coding… still read the docs. But why do developers still turn to Stack Overflow or tools like ChatGPT for answers? Often, it’s because documentation is an afterthought; hard to navigate, incomplete, or not written with the user in mind. Documentation is typically the first point of contact for your project. As a maintainer, you can’t walk every contributor through the process step by step. As an organization, not everyone will watch your demo video. You need documentation that advocates for your project and helps people get what they need. According to the 2024 GitHub Open Source Survey, clear contribution guidelines are among the top factors that influence contributions to a project. In this talk, you’ll learn how to make your documentation work for you and your project. We’ll cover: - How good documentation enhances the developer experience - Creating interactive docs with tools like Swagger UI, StackBlitz, CodeSandbox, and Replit - How to write an effective README & contribution guide - Structuring docs for different users with the Diátaxis framework - Embedding interactive demos with MDX or sandboxing tools - Treating docs as code to improve maintenance and collaboration - Localization tools to make your docs accessible to a global audience

open-source

Creating documentation that developers will actually read

Sobre Damilola Ezekiel

Damilola Ezekiel

Developer Advocate &Technical Writer

Damilola Ezekiel is a technical writer and open source contributor passionate about improving developer experience through better documentation. She’s contributed to and created open source projects, leads TechWriters Hub, and advocates for non-code contributions in the tech ecosystem. She also curates practical content on documentation, DevRel, and developer education.

𝕏 Twitter LinkedIn