Luise Freese

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

Why is the task developers hate most also the one they rely on? Discover how documentation can transform you into a more effective and efficient programmer.

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

Understanding the developer paradox with documentation

Developers often hate writing documentation but heavily rely on it, creating a paradox that highlights its fundamental importance.

#2about 2 minutes

Defining what product documentation truly means

Product documentation is more than just README files or inline comments; it's a comprehensive set of documents for the development team.

#3about 8 minutes

Exploring the essential types of product documentation

A breakdown of key documentation types including specs, design descriptions, API guides, UX docs, and the product roadmap is provided.

#4about 5 minutes

The business case for investing in documentation

Good documentation ensures software success by unifying information, facilitating knowledge sharing, and keeping projects on budget and on time.

#5about 1 minute

Using documentation to improve future projects

Documenting lessons learned and mistakes helps prevent teams from repeating the same errors in subsequent projects.

#6about 5 minutes

How writing documentation improves your development skills

The act of documenting code and architecture enhances your own understanding, improves team communication, and simplifies maintenance and debugging.

#7about 2 minutes

Practical tips for making documentation a habit

Incorporate documentation into your workflow by creating specific tasks, trying pair writing, and treating it as a living document.

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

Job ad Dark

SabIna compys

SabIna compys
Vienna, Austria

Remote
€20-100K
Intermediate
JavaScript
.NET
+1

Matching moments

Why documentation is essential for team collaboration
01:53 MIN

Why documentation is essential for team collaboration

Continuous Documentation for Your Code

The importance of creating reusable and discoverable documentation
05:36 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

Why documenting architectural decisions is crucial
06:39 MIN

Why documenting architectural decisions is crucial

Work efficiently with Architecture Decision Records (ADRs)

Why great documentation is a cornerstone
01:32 MIN

Why great documentation is a cornerstone

Measuring Project Health in Open Source

Final thoughts on audience-centric documentation and tools
03:04 MIN

Final thoughts on audience-centric documentation and tools

Communicate efficiently with Software Architecture Diagrams

Fostering a team culture of writing and reading docs
02:45 MIN

Fostering a team culture of writing and reading docs

Continuous Documentation for Your Code

Investing in better documentation writing and training
00:31 MIN

Investing in better documentation writing and training

Building Developer Experience - Brick by Brick

Common challenges in architecture documentation
01:52 MIN

Common challenges in architecture documentation

42 x 2 Canvases Later: Two Years, Two Minds, Many Lessons

Featured Partners

Related Videos

See all videos
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

Continuous Documentation for Your Code20:19

Continuous Documentation for Your Code

Anastasiia Tymoshchuk

AI-Powered Code Documentation: Simplify the Complex28:22

AI-Powered Code Documentation: Simplify the Complex

Patrick Schnell

Humanizing Your Documentation27:25

Humanizing Your Documentation

Carolyn Stransky

Documentation as a Tool: Introducing Documentation Driven Development22:45

Documentation as a Tool: Introducing Documentation Driven Development

Abiodun Olowode

Architecture Communication Canvas26:15

Architecture Communication Canvas

Gernot Starke & Benjamin Wolf

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

Work efficiently with Architecture Decision Records (ADRs)

Johannes Dienst

Communicate efficiently with Software Architecture Diagrams28:11

Communicate efficiently with Software Architecture Diagrams

Simon Lasselsberger

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
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
PH
Pearl Holland
7 Best Steps For Writing Good Software Technical Documentation
The manuals, tutorials, and other documentation materials cover a software product's development, functionality, and use. It is just one type of technical documentation among many.Software documentation serves the straightforward goal of streamlining...
7 Best Steps For Writing Good Software Technical Documentation

From learning to earning

Jobs that call for the skills explored in this talk.