Self-documenting source code

Everyone appreciates well-written documentation. Yet, when it comes to our own projects, we often prioritise speed, and skip the documentation altogether. We don’t have the time to read, let alone write, pages of text.

However, when we’re faced with understanding code written by a colleague—or even our past selves—we find ourselves longing for explanations.

In this talk, we’ll explore what software documentation really is, the various formats it can take, and how to choose the right documentation approach for different types of projects. We’ll also discuss techniques for writing self-documenting code that enhances understanding for future readers, minimising the need for formal documentation without compromising clarity.

📣 Speaker: Ines Jelovac Mandarić

⏰ Schedule:
👋 Introduction (10min)
🎤 Self-documenting source code + Q&A (1h)
🥕 Munching (30min)
⚡ Lightning talks

⚡ Lightning talk plan: Strictly 5mins or less per talk; topics reported on-site; talks continue until no more speakers.

©️ Cover image by Freepik.