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.
#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
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
01:32 MIN
Why great documentation is a cornerstone
Measuring Project Health in Open Source
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
02:50 MIN
Data-backed benefits of documentation for developer experience
Documentation as a Tool: Introducing Documentation Driven Development
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
04:03 MIN
The high cost of poor or missing code documentation
AI-Powered Code Documentation: Simplify the Complex
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
03:29 MIN
Introducing Documentation-Driven Development (DDD)
Documentation as a Tool: Introducing Documentation Driven Development
The real reason we document our codeThe 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...
Benedikt Bischof
Humanizing Your DocumentationAbout 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...
Stephen McKenna
Technical Documentation For DevelopersTechnical 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...
25:25
31:23
28:16
22:45
28:22
27:25
26:15
35:31
