Anastasiia Tymoshchuk

Continuous Documentation for Your Code

Is readable code a substitute for documentation? Discover the four types of docs your project is missing and how to automate their creation with every pull request.

Continuous Documentation for Your Code
#1about 6 minutes

The challenge of maintaining code without documentation

Undocumented code feels unfinished and becomes difficult to understand or improve over time, even for the original author.

#2about 15 minutes

Understanding the four distinct types of documentation

Documentation is categorized into four types: goal-oriented how-to guides, learning-oriented tutorials, understanding-oriented explanations, and information-oriented references.

#3about 2 minutes

Why documentation is essential for team collaboration

Documentation is critical because developers forget details, leave projects, and new contributors need a way to get up to speed.

#4about 5 minutes

Tools for continuous documentation in React and Python

Implement continuous documentation using tools like Storybook for React components or Sphinx and Read the Docs for Python projects.

#5about 3 minutes

Fostering a team culture of writing and reading docs

Effective documentation relies on building a team culture where writing and consulting docs is a standard part of the development workflow.

#6about 7 minutes

Q&A on readable code, coverage, and diagrams

Readable code is not a substitute for documentation, coverage can be measured with CI tools, and diagrams like the C4 model are valuable additions.

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

Matching moments

Why great documentation is a cornerstone
11:08 MIN

Why great documentation is a cornerstone

Measuring Project Health in Open Source

How writing documentation improves your development skills
19:01 MIN

How writing documentation improves your development skills

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

Practical tips for making documentation a habit
23:42 MIN

Practical tips for making documentation a habit

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

Data-backed benefits of documentation for developer experience
19:55 MIN

Data-backed benefits of documentation for developer experience

Documentation as a Tool: Introducing Documentation Driven Development

Using documentation to improve future projects
18:04 MIN

Using documentation to improve future projects

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

Using docs-as-code to keep documentation up to date
20:08 MIN

Using docs-as-code to keep documentation up to date

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

Introducing Documentation-Driven Development (DDD)
00:32 MIN

Introducing Documentation-Driven Development (DDD)

Documentation as a Tool: Introducing Documentation Driven Development

Identifying what to document in your daily work
02:50 MIN

Identifying what to document in your daily work

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

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

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

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

AI-Powered Code Documentation: Simplify the Complex28:22

AI-Powered Code Documentation: Simplify the Complex

Patrick Schnell

Architecture Communication Canvas26:15

Architecture Communication Canvas

Gernot Starke & Benjamin Wolf

Building a large, complex product from the ground up with typescript & Atomic Design:lessons learned28:13

Building a large, complex product from the ground up with typescript & Atomic Design:lessons learned

Nathalia Rus

300 days straight of helping on stackoverflow42:54

300 days straight of helping on stackoverflow

Konstantin BIFERT

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
What Developers Really Need to Create Great Code Demos
Every developer on earth has, at some point, had another developer to thank for a breakthrough, a success, an aha moment they wouldn’t have had without coming across that blog post, that open-source contribution, that reply on socials or that humble ...
What Developers Really Need to Create Great Code Demos
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.

Rust and GoLang

Rust and GoLang

NHe4a GmbH
Karlsruhe, Germany

Remote
€55-65K
Intermediate
Senior
Go
Rust