WeAreDevelopers Logo WeAreDevelopers
Sign in
For You LIVE
World Congress 2023 • Sep 21, 2023

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

Hila Fish

Still hoping your code is self-documenting? Discover how adopting Docs-as-Code prevents frustrating midnight incidents, accelerates onboarding, and permanently eliminates single points of failure.

Pause
Mute Enter Fullscreen
#1 about 3 min

Introduction and the value of runbooks

How clear runbooks help mitigate production incidents and reduce downtime during out-of-hours on-call shifts.

#2 about 2 min

Identifying common types of technical documentation

How system design briefs, project readme files, and onboarding outlines share essential team knowledge.

#3 about 1 min

Debunking the myth of self-documenting code

Why code syntax alone cannot convey business logic, architectural intentions, or reasoning behind complex implementations.

#4 about 7 min

Career and team benefits of writing documentation

How documenting internal processes reduces daily interruptions while increasing team velocity and individual visibility.

#5 about 4 min

Adapting technical documentation for diverse audiences

Identifying what concepts must be covered for internal operating systems versus external API consumers.

#6 about 1 min

Establishing centralized documentation and storage standards

How adopting a single knowledge base minimizes context switching and helps teams locate resources quickly.

#7 about 3 min

Formatting documentation for fast developer scannability

Structuring technical guides with clear headings, short sentences, and color emphasis to support quick developer scanning.

#8 about 3 min

Incorporating docs as code into CI/CD pipelines

Applying markdown and automated pipeline validations to treat documentation quality as strictly as software tests.

#9 about 3 min

Separating technical concepts from instructional tasks

Structuring content to decouple high-level architectural reasoning from actionable step-by-step procedure guides.

#10 about 3 min

Enforcing documentation requirements in operational workflows

Equipping engineering managers to require updated documentation as an undeniable part of the definition of done.

#11 about 4 min

Addressing AI assistance and documentation tooling

Addressing audience questions about using large language models and tracking documentation updates across various code repositories.

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

4:57 min

Treating technical documentation as a core engineering practice

Mike Elsmore · World Congress 2023

3:08 min

Treating developer documentation as a primary product

Justin Kitagawa · Coffee With Developers

1:24 min

Building an engineering culture around reading and writing documentation

Anastasiia Tymoshchuk · World Congress 2023

6:03 min

Driving business objectives through comprehensive technical documentation

Luise Freese Luise Freese · World Congress 2024

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
over 2 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 · 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 · 14:50–15:20

Tech Leaders Stage

Keeping Code Quality at AI Speed

Daksh Gupta, Arthur Hicken, Brian Mann

Daksh Gupta
Arthur Hicken
Brian Mann
Open session

World Congress 2026 North America

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

Stage 1

The Broken Rung: How AI is Rebuilding Software Development from the Ground Up

Tomislav Tipurić

Chief Technology Officer, Nephos

Tomislav Tipurić
Open session

World Congress 2026 North America

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

Tech Leaders Stage

Rethinking Developer Tools for the Agent Era

Han Wang, Sam Bhagwat

Han Wang
Sam Bhagwat
Open session

World Congress 2026 North America

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

Outdoor Stage

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 24, 2026 · 16:50–17:20

Mainstage

Building AI Products vs. Building With AI

Aparna Dhinakaran, Rukmini Reddy, Tamar Bercovici

Aparna Dhinakaran
Rukmini Reddy
Tamar Bercovici

Related videos

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

Humanizing Your Documentation

Carolyn Stransky

Continuous Documentation for Your Code thumbnail
20:19
World Congress 2023 • almost 3 years ago

Continuous Documentation for Your Code

Anastasiia Tymoshchuk

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

Living Documentation That Can't Die

Roman Liukevich

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

Your Docs Are Now AI Infrastructure (Treat Them Like It) thumbnail
9:29
World Congress 2026 Europe • 2 months ago

Your Docs Are Now AI Infrastructure (Treat Them Like It)

Emil Sorensen

Making Documentation AI-Ready: Preparing Your Docs for the LLM Era thumbnail
27:16
World Congress 2026 Europe • 2 months ago

Making Documentation AI-Ready: Preparing Your Docs for the LLM Era

Edvin Teskeredzic

Related articles

From learning to earning

Jobs that call for the skills explored in this talk.