Abiodun Olowode

Documentation as a Tool: Introducing Documentation Driven Development

What if writing documentation first could prevent costly mistakes and accelerate your entire development cycle?

Documentation as a Tool: Introducing Documentation Driven Development
#1about 3 minutes

Introducing Documentation-Driven Development (DDD)

The principle of "document first, code later" is introduced as a proactive tool for improving the development process.

#2about 4 minutes

Improving collaboration with asynchronous documentation

Asynchronous documentation avoids the cognitive load and chaos of real-time tools like Slack, enabling more effective team collaboration across time zones.

#3about 3 minutes

Gaining faster feedback to accelerate development

Documenting a proposed solution first allows for early feedback from stakeholders, preventing costly rework and accelerating the development cycle.

#4about 2 minutes

Capturing the 'why' for easier future maintenance

Documentation provides essential context on design decisions, explaining the "why" behind the code to simplify future maintenance and onboarding.

#5about 3 minutes

Implementing DDD with a Request for Comments (RFC) process

The Request for Comments (RFC) process is a practical way to implement DDD, creating a centralized, linkable record of technical discussions and decisions.

#6about 4 minutes

The key components of an effective RFC template

An effective RFC template should include sections for motivation, background, a detailed proposal, and success criteria to guide clear and productive discussions.

#7about 3 minutes

Data-backed benefits of documentation for developer experience

Citing a GitHub study, comprehensive documentation is shown to cut technical debt, prevent duplicated effort, and significantly boost developer productivity.

Related jobs
Jobs that call for the skills explored in this talk.

d

Saby Company
Delebio, Italy

Junior

job ad

Saby Company
Delebio, Italy

Intermediate

Matching moments

Creating effective documentation for future contributors
10:58 MIN

Creating effective documentation for future contributors

Open sourcing a library: how hard can that be?

Why documentation is essential for team collaboration
20:25 MIN

Why documentation is essential for team collaboration

Continuous Documentation for Your Code

Viewing DDD as a holistic software engineering approach
05:06 MIN

Viewing DDD as a holistic software engineering approach

20 Years of Domain-Driven Design: What I’ve Learned About DDD

The importance of creating reusable and discoverable documentation
38:14 MIN

The importance of creating reusable and discoverable documentation

WeAreDevelopers LIVE - Blockchain after the hype, Vibing all the Things, Big Tech and Work Best Practices & more

Q&A on DevEx teams and documentation strategy
19:11 MIN

Q&A on DevEx teams and documentation strategy

Enhancing Developer Experience During Architecture Modernization

Shifting documentation earlier in the development lifecycle
06:22 MIN

Shifting documentation earlier in the development lifecycle

Humanizing Your Documentation

Summary of key lessons from 20 years of DDD
27:30 MIN

Summary of key lessons from 20 years of DDD

20 Years of Domain-Driven Design: What I’ve Learned About DDD

Introduction to Domain-Driven Design and sustainability
00:14 MIN

Introduction to Domain-Driven Design and sustainability

It’s all about the domain, honey ! Experiences from 15 years of Domain-Driven Design

Featured Partners

Related Videos

See all videos
"I will remember that" and other lies - Why documentation matters and it makes your apps better25:25

"I will remember that" and other lies - Why documentation matters and it makes your apps better

Luise Freese

Work efficiently with Architecture Decision Records (ADRs)50:22

Work efficiently with Architecture Decision Records (ADRs)

Johannes Dienst

Continuous Documentation for Your Code20:19

Continuous Documentation for Your Code

Anastasiia Tymoshchuk

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

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

Hila Fish

It’s all about the domain, honey ! Experiences from 15 years of Domain-Driven Design43:13

It’s all about the domain, honey ! Experiences from 15 years of Domain-Driven Design

Carola Lilienthal

20 Years of Domain-Driven Design: What I’ve Learned About DDD29:11

20 Years of Domain-Driven Design: What I’ve Learned About DDD

Eberhard Wolff

Architecture Communication Canvas26:15

Architecture Communication Canvas

Gernot Starke & Benjamin Wolf

AI-Powered Code Documentation: Simplify the Complex28:22

AI-Powered Code Documentation: Simplify the Complex

Patrick Schnell

Related Articles

View all articles
DC
Daniel Cranney
The real reason we document our code
The world of software development moves fast. Technology is constantly changing, as are the tools we use with it, and even the role of a programmer is itself constantly in flux. However, some aspects of software engineering are so foundational that w...
The real reason we document our code
DC
Daniel Cranney
Why developer experience matters
With technology embedded in almost every aspect of life, and with developers building and maintaining these tools, it’s ensuring that developers operate in the digital world with speed and efficiency, if we are to see these same benefits in the offli...
Why developer experience matters
BB
Benedikt Bischof
Humanizing Your Documentation
About the speaker:Carolyn Stransky is a journalist, software engineer, conference speaker and technical writer based in Berlin. This is how she describes herself on her website:Majority of the week, I'm a frontend engineer focused on accessibility, d...
Humanizing Your Documentation
SM
Stephen McKenna
Technical Documentation For Developers
Technical documentation is an old strategy but essential in web development. However, it’s often a neglected part of the software development process. When done well, it can make a huge difference in the usability and quality of a product. But unfort...
Technical Documentation For Developers

From learning to earning

Jobs that call for the skills explored in this talk.