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.

Remote

Name of

Name of

Remote
Intermediate
PHP
Java
+1

Matching moments

How writing documentation improves your development skills
04:41 MIN

How writing documentation improves your development skills

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

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
Why great documentation is a cornerstone
01:32 MIN

Why great documentation is a cornerstone

Measuring Project Health in Open Source

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
Practical tips for making documentation a habit
01:43 MIN

Practical tips for making documentation a habit

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

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
Data-backed benefits of documentation for developer experience
02:50 MIN

Data-backed benefits of documentation for developer experience

Documentation as a Tool: Introducing Documentation Driven Development

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
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

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
The high cost of poor or missing code documentation
04:03 MIN

The high cost of poor or missing code documentation

AI-Powered Code Documentation: Simplify the Complex

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
Using documentation to improve future projects
00:57 MIN

Using documentation to improve future projects

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

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.
Introducing Documentation-Driven Development (DDD)
03:29 MIN

Introducing Documentation-Driven Development (DDD)

Documentation as a Tool: Introducing Documentation Driven Development

Unlock Moments
Create a free account to watch a limited number of Moments each month.
Upgrade to PRO for unlimited access to the full archive.

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

Navigating the Corporate Jungle: Life as a Developer in a large Company28:16

Navigating the Corporate Jungle: Life as a Developer in a large Company

Alexandra Petri

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

Humanizing Your Documentation27:25

Humanizing Your Documentation

Carolyn Stransky

Architecture Communication Canvas26:15

Architecture Communication Canvas

Gernot Starke & Benjamin Wolf

How we will build the software of tomorrow35:31

How we will build the software of tomorrow

Thomas Dohmke

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

From learning to earning

Jobs that call for the skills explored in this talk.

Senior QA Engineer

Senior QA Engineer

CheckYeti
Vienna, Austria

Senior
Selenium
JavaScript
Manual Testing
Automated Testing