WeAreDevelopers Logo WeAreDevelopers
Sign in
For You LIVE
World Congress 2023 • Oct 23, 2023

Continuous Documentation for Your Code

Anastasiia Tymoshchuk

Clean code cannot document its own business logic. Learn how embedding continuous documentation into your PR process keeps your codebase alive, accessible, and deeply collaborative.

Pause
Mute Enter Fullscreen
#1 about 4 min

Discovering the long-term value of continuous software code documentation

How early experiences writing unstructured code demonstrate the need for evaluating completeness before passing it entirely to the future.

#2 about 2 min

Recognizing the four distinct frameworks of software engineering documentation

An analogy of a lost piece of code introduces distinct categories needed to properly inform other engineering teams.

#3 about 2 min

Using goal-oriented documentation to create practical how-to guides

Writing step-by-step directions helps unblock developers when trying to fulfill specific tasks like installation operations.

#4 about 2 min

Designing learning-oriented tutorials to build complete framework knowledge

Structuring detailed tutorials enables developers to learn new paradigms rather than simply copying a fast recipe.

#5 about 1 min

Using understanding-oriented documentation to explain integrations and software architecture

Highlighting architectural motivations and integrations helps broaden the technical understanding of how separate components interact together.

#6 about 4 min

Generating information-oriented reference documentation directly from source code

Using tools alongside code annotations automatically produces technical specifications that dynamically update with releases.

#7 about 2 min

Preventing code abandonment by preserving original context and motivation

Without clear context, transitioning or onboarding developers struggle to manage legacy logic that original creators inevitably forget.

#8 about 4 min

Implementing continuous documentation tooling for shared components and services

Consolidating resources with automated environments ensures documentation scales cleanly alongside deployments for different programming ecosystems.

#9 about 2 min

Building an engineering culture around reading and writing documentation

Fostering a team habit of searching existing resources ensures the documentation loop remains actively updated and utilized.

#10 about 2 min

Balancing readable code practices with comprehensive documentation coverage metrics

Evaluating documentation completeness through automated tools supports architecture models while acknowledging the limits of purely readable logic.

Matching moments

2:49 min

Boosting team productivity with comprehensive engineering documentation

Abiodun Olowode Abiodun Olowode · World Congress 2024

1:58 min

Designing technical documentation for cross-functional audiences

Simon Lasselsberger · World Congress 2022

6:51 min

Career and team benefits of writing documentation

Hila Fish · World Congress 2023

2:22 min

Incorporating docs as code into CI/CD pipelines

Hila Fish · World Congress 2023

4:57 min

Treating technical documentation as a core engineering practice

Mike Elsmore · World Congress 2023

1:14 min

Creating discoverable and accessible library documentation

Vadzim Prudnikau Vadzim Prudnikau · World Congress 2026 Europe

More from World Congress 2023

The year 3000, a brief history of Web Development thumbnail
25:30
over 2 years ago

The year 3000, a brief history of Web Development

Lorenzo Pieri

Demografie nutzen um jedem Bewerber das passende Angebot zu machen! thumbnail
8:52
almost 3 years ago

Demografie nutzen um jedem Bewerber das passende Angebot zu machen!

Nathalie Gierth

Guided Memory Management: Rust's Ownership Model thumbnail
0:18
almost 3 years ago

Guided Memory Management: Rust's Ownership Model

Stefan Baumgartner

Passwordless future: WebAuthn and Passkeys in practice thumbnail
32:32
almost 3 years ago

Passwordless future: WebAuthn and Passkeys in practice

Clemens Hübner

External Secrets Operator: the secrets management toolbox for self-sufficient teams thumbnail
30:07
almost 3 years ago

External Secrets Operator: the secrets management toolbox for self-sufficient teams

Moritz Johner

Building Reliable Serverless Applications with AWS CDK and Testing thumbnail
25:18
almost 3 years ago

Building Reliable Serverless Applications with AWS CDK and Testing

Raphael Manke

Upcoming sessions on this topic

Open session

World Congress 2026 North America

September 24, 2026 · 16:50–17:20

Stage 1

When Humans Stop Writing Code: Rethinking Languages, Compilers, and Responsibility

Simon Auer

Organizer of flutter vienna meetup and CEO of marqably

Simon Auer
Open session

World Congress 2026 North America

September 25, 2026 · 14:50–15:20

Tech Leaders Stage

Keeping Code Quality at AI Speed

Daksh Gupta, Arthur Hicken, Jack Danger, Francesco Ciulla

Daksh Gupta
Arthur Hicken
Jack Danger
Francesco Ciulla
Open session

World Congress 2026 North America

September 24, 2026 · 15:30–16:00

Stage 6

Going beyond the code through the GitHub Copilot App: how to unlock you and your team’s superpower

Jenny Hwang

Director of User Research at GitHub

Jenny Hwang
Open session

World Congress 2026 North America

September 25, 2026 · 11:40–12:10

Stage 3

Culture Doesn't Scale Itself: Leading Engineering Teams Through Hypergrowth and the AI Transition

Thanos Baskous

VP of Engineering and Co-founder of Cogent Security

Thanos Baskous
Open session

World Congress 2026 North America

September 24, 2026 · 14:10–14:40

Stage 4

Agentic Drift: keeping pace with your agents

John Coghlan

Senior Director, Developer Advocacy at GitLab

John Coghlan
Open session

World Congress 2026 North America

September 23, 2026 · 15:00–15:30

Stage 2

How GitHub Helps Two Maintainers Serve 6,000 Learners

Gwyneth Peña-Siguenza

Senior Cloud Advocate at GitHub

Gwyneth Peña-Siguenza

Related videos

Technical Documentation - How Can I Write Them Better and Why Should I Care? thumbnail
31:23
World Congress 2023 • about 3 years ago

Technical Documentation - How Can I Write Them Better and Why Should I Care?

Hila Fish

Living Documentation That Can't Die thumbnail
19:16
Europe 2026 Virtual • 3 months ago

Living Documentation That Can't Die

Roman Liukevich

Humanizing Your Documentation thumbnail
27:25
World Congress 2022 • over 4 years ago

Humanizing Your Documentation

Carolyn Stransky

Documentation as a Tool: Introducing Documentation Driven Development thumbnail
22:45
World Congress 2024 • about 2 years ago

Documentation as a Tool: Introducing Documentation Driven Development

Abiodun Olowode

One Developer Journey, Two Surfaces thumbnail
29:13
Europe 2026 Virtual • 3 months ago

One Developer Journey, Two Surfaces

Saif Ali Shaik

Keep your code refactorable thumbnail
26:46
World Congress 2022 • over 4 years ago

Keep your code refactorable

Gerrit Stapper

Related articles

From learning to earning

Jobs that call for the skills explored in this talk.