SlideShare a Scribd company logo

PyCon Estonia: Contemporary Documentation

My slides from my talk Contemporary Documentation. Find more info about it here: https://hamatti.org/talks/contemporary-documentation/

1 of 30
Download to read offline
CONTEMPORARY DOCUMENTATION
PyCon Estonia • Juha-Matti Santala • October 3rd 2019
CONTEMPORARY
/kənˈtɛm.pəˌɹɛɹ.i/
1. From the same time period, 

coexistent in time. 

2. Modern, of the present age
@hamattiPyCon Estonia 2019
HI, I’M JUHIS
Developer Advocate @ Futurice
Founder of Turku <3 Frontend
Background in startups & consulting
@hamatti in Twitter
from Helsinki, !
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
TEAMS CHANGE
DOCUMENTATION SHOULD
@hamattiPyCon Estonia 2019
PROVIDE CONTEXT
(MOST OF THE)
DOCUMENTATION
IS
A LIVING ORGANISM
@hamattiPyCon Estonia 2019
(README, API DOCS, CODE COMMENTS)
COMMIT
MESSAGES
@hamattiPyCon Estonia 2019
CODE
REVIEW
STORIES &

TASKS
3 BRANCHES
@hamattiPyCon Estonia 2019
It’s hard because
the reward
comes later
COMMIT MESSAGE
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
https://xkcd.com/1296/
@hamattiPyCon Estonia 2019
“What would you like
to know two years
from now?”
@hamattiPyCon Estonia 2019
“What would you ask
from a colleague who
wrote this two years
ago?”
@hamattiPyCon Estonia 2019 https: //chris.beams.io/posts/git-commit/
CODE REVIEW
@hamattiPyCon Estonia 2019
https://github.com/facebook/react/pull/16302
WRITE IT DOWN
@hamattiPyCon Estonia 2019
ASK A LOT OF QUESTIONS
DON’T DELETE COMMENTS
STORIES & TASKS
@hamattiPyCon Estonia 2019
STORIES & TASKS
@hamattiPyCon Estonia 2019
Origin / Business Driver
How to reproduce?
Definition of Done
Clarifying questions
WRITE IT DOWN
@hamattiPyCon Estonia 2019
DOCUMENTATION WORKFLOW
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
@hamattiPyCon Estonia 2019
RECAP
@hamatti
COMMIT MSG, CODE REVIEW & ISSUES
“WHAT WOULD I WANT TO KNOW IN 2 YEARS”
WRITE IT DOWN
PyCon Estonia 2019
FRIDAY HUG
@hamattiPyCon Estonia 2019
THANK YOU!
@hamattiPyCon Estonia 2019
@hamatti
https://hamatti.org
juhis@futurice.com
PS. I run a developer newsletter called
Dev Breakfast at
hello.futurice.com/dev-breakfast

Recommended

Contemporary Documentation - HelsinkiJS
Contemporary Documentation - HelsinkiJSContemporary Documentation - HelsinkiJS
Contemporary Documentation - HelsinkiJSJuha-Matti Santala
 
Contemporary Documentation - TampereJS
Contemporary Documentation - TampereJSContemporary Documentation - TampereJS
Contemporary Documentation - TampereJSJuha-Matti Santala
 
Contemporary Documentation @ PyAmsterdam, 2021-03-10
Contemporary Documentation @ PyAmsterdam, 2021-03-10Contemporary Documentation @ PyAmsterdam, 2021-03-10
Contemporary Documentation @ PyAmsterdam, 2021-03-10Juha-Matti Santala
 
Contemporary Documentation @ sthml.js
Contemporary Documentation @ sthml.jsContemporary Documentation @ sthml.js
Contemporary Documentation @ sthml.jsJuha-Matti Santala
 
Debugging Django @ HelPy, Juha-Matti Santala 24.5.2022
Debugging Django @ HelPy, Juha-Matti Santala 24.5.2022Debugging Django @ HelPy, Juha-Matti Santala 24.5.2022
Debugging Django @ HelPy, Juha-Matti Santala 24.5.2022Juha-Matti Santala
 
Learning Rust - experiences from a Python/Javascript developer
Learning Rust - experiences from a Python/Javascript developerLearning Rust - experiences from a Python/Javascript developer
Learning Rust - experiences from a Python/Javascript developerJuha-Matti Santala
 

More Related Content

More from Juha-Matti Santala

Contemporary Documentation, Django Day Copenhagen
Contemporary Documentation, Django Day CopenhagenContemporary Documentation, Django Day Copenhagen
Contemporary Documentation, Django Day CopenhagenJuha-Matti Santala
 
Debugging Python - Python Users Berlin 14.5.2020
Debugging Python - Python Users Berlin 14.5.2020Debugging Python - Python Users Berlin 14.5.2020
Debugging Python - Python Users Berlin 14.5.2020Juha-Matti Santala
 
Debugging Javascript - Munich Frontend Developers 13.5.2020
Debugging Javascript - Munich Frontend Developers 13.5.2020Debugging Javascript - Munich Frontend Developers 13.5.2020
Debugging Javascript - Munich Frontend Developers 13.5.2020Juha-Matti Santala
 
HelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UX
HelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UXHelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UX
HelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UXJuha-Matti Santala
 
“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...
“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...
“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...Juha-Matti Santala
 
PyCon CZ 2019 Lightning Talk: 7 Days to Ostrava
PyCon CZ 2019 Lightning Talk: 7 Days to OstravaPyCon CZ 2019 Lightning Talk: 7 Days to Ostrava
PyCon CZ 2019 Lightning Talk: 7 Days to OstravaJuha-Matti Santala
 
Inspiration, Learning and Experimentation in Codepen
Inspiration, Learning and Experimentation in CodepenInspiration, Learning and Experimentation in Codepen
Inspiration, Learning and Experimentation in CodepenJuha-Matti Santala
 
You should have FOMO: What you're missing out if you're still using Python 2.7
You should have FOMO: What you're missing out if you're still using Python 2.7You should have FOMO: What you're missing out if you're still using Python 2.7
You should have FOMO: What you're missing out if you're still using Python 2.7Juha-Matti Santala
 
OuluES Human Accelerator: Dream Workshop
OuluES Human Accelerator: Dream WorkshopOuluES Human Accelerator: Dream Workshop
OuluES Human Accelerator: Dream WorkshopJuha-Matti Santala
 
Minimum Viable Product: the workshop
Minimum Viable Product: the workshopMinimum Viable Product: the workshop
Minimum Viable Product: the workshopJuha-Matti Santala
 
Stockholm syndrome: or how I learned to love the editor
Stockholm syndrome: or how I learned to love the editorStockholm syndrome: or how I learned to love the editor
Stockholm syndrome: or how I learned to love the editorJuha-Matti Santala
 
Happy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of Debugging Happy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of Debugging Juha-Matti Santala
 
Happy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of DebuggingHappy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of DebuggingJuha-Matti Santala
 
Dream Workshop @ Boost Human Accelerator
Dream Workshop @ Boost Human AcceleratorDream Workshop @ Boost Human Accelerator
Dream Workshop @ Boost Human AcceleratorJuha-Matti Santala
 
Communities in Marketing - Perjantaipresis
Communities in Marketing - PerjantaipresisCommunities in Marketing - Perjantaipresis
Communities in Marketing - PerjantaipresisJuha-Matti Santala
 
Why the fuck would anyone hire you - how to make yourself appealing at the jo...
Why the fuck would anyone hire you - how to make yourself appealing at the jo...Why the fuck would anyone hire you - how to make yourself appealing at the jo...
Why the fuck would anyone hire you - how to make yourself appealing at the jo...Juha-Matti Santala
 

More from Juha-Matti Santala (17)

Contemporary Documentation, Django Day Copenhagen
Contemporary Documentation, Django Day CopenhagenContemporary Documentation, Django Day Copenhagen
Contemporary Documentation, Django Day Copenhagen
 
Debugging Python - Python Users Berlin 14.5.2020
Debugging Python - Python Users Berlin 14.5.2020Debugging Python - Python Users Berlin 14.5.2020
Debugging Python - Python Users Berlin 14.5.2020
 
Debugging Javascript - Munich Frontend Developers 13.5.2020
Debugging Javascript - Munich Frontend Developers 13.5.2020Debugging Javascript - Munich Frontend Developers 13.5.2020
Debugging Javascript - Munich Frontend Developers 13.5.2020
 
HelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UX
HelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UXHelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UX
HelsinkiJS: 11ty + Ghost: Static Sites with Great Editor UX
 
“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...
“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...
“Graphical Perception and Graphical Methods for Analyzing Scientific Data” - ...
 
PyCon CZ 2019 Lightning Talk: 7 Days to Ostrava
PyCon CZ 2019 Lightning Talk: 7 Days to OstravaPyCon CZ 2019 Lightning Talk: 7 Days to Ostrava
PyCon CZ 2019 Lightning Talk: 7 Days to Ostrava
 
Inspiration, Learning and Experimentation in Codepen
Inspiration, Learning and Experimentation in CodepenInspiration, Learning and Experimentation in Codepen
Inspiration, Learning and Experimentation in Codepen
 
You should have FOMO: What you're missing out if you're still using Python 2.7
You should have FOMO: What you're missing out if you're still using Python 2.7You should have FOMO: What you're missing out if you're still using Python 2.7
You should have FOMO: What you're missing out if you're still using Python 2.7
 
OuluES Human Accelerator: Dream Workshop
OuluES Human Accelerator: Dream WorkshopOuluES Human Accelerator: Dream Workshop
OuluES Human Accelerator: Dream Workshop
 
Minimum Viable Product: the workshop
Minimum Viable Product: the workshopMinimum Viable Product: the workshop
Minimum Viable Product: the workshop
 
Stockholm syndrome: or how I learned to love the editor
Stockholm syndrome: or how I learned to love the editorStockholm syndrome: or how I learned to love the editor
Stockholm syndrome: or how I learned to love the editor
 
Happy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of Debugging Happy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of Debugging
 
Happy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of DebuggingHappy Little Accidents - The Art of Debugging
Happy Little Accidents - The Art of Debugging
 
Dream Workshop @ Boost Human Accelerator
Dream Workshop @ Boost Human AcceleratorDream Workshop @ Boost Human Accelerator
Dream Workshop @ Boost Human Accelerator
 
Communities in Marketing - Perjantaipresis
Communities in Marketing - PerjantaipresisCommunities in Marketing - Perjantaipresis
Communities in Marketing - Perjantaipresis
 
Why the fuck would anyone hire you - how to make yourself appealing at the jo...
Why the fuck would anyone hire you - how to make yourself appealing at the jo...Why the fuck would anyone hire you - how to make yourself appealing at the jo...
Why the fuck would anyone hire you - how to make yourself appealing at the jo...
 
Pitching 101
Pitching 101Pitching 101
Pitching 101
 

Recently uploaded

Large Language Models and Applications in Healthcare
Large Language Models and Applications in HealthcareLarge Language Models and Applications in Healthcare
Large Language Models and Applications in HealthcareAsma Ben Abacha
 
VM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlue
VM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlueVM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlue
VM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlueShapeBlue
 
Trading Software Development_ Trends to Watch in 2024.pdf
Trading Software Development_ Trends to Watch in 2024.pdfTrading Software Development_ Trends to Watch in 2024.pdf
Trading Software Development_ Trends to Watch in 2024.pdfLucas Lagone
 
AGFM - Toyota Coaster 1HZ Install Guide.pdf
AGFM - Toyota Coaster 1HZ Install Guide.pdfAGFM - Toyota Coaster 1HZ Install Guide.pdf
AGFM - Toyota Coaster 1HZ Install Guide.pdfRodneyThomas28
 
Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...
Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...
Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...ShapeBlue
 
eXtended Reality(XR) Basic introductions
eXtended Reality(XR) Basic introductionseXtended Reality(XR) Basic introductions
eXtended Reality(XR) Basic introductionsElanthirayan Madhavan
 
Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)
Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)
Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)Jay Zhao
 
Q4 2023 Quarterly Investor Presentation - FINAL.pdf
Q4 2023 Quarterly Investor Presentation - FINAL.pdfQ4 2023 Quarterly Investor Presentation - FINAL.pdf
Q4 2023 Quarterly Investor Presentation - FINAL.pdfTejal81
 
TrustArc Webinar - TrustArc's Latest AI Innovations
TrustArc Webinar - TrustArc's Latest AI InnovationsTrustArc Webinar - TrustArc's Latest AI Innovations
TrustArc Webinar - TrustArc's Latest AI InnovationsTrustArc
 
iOncologi_Pitch Deck_2024 slide show for hostinger
iOncologi_Pitch Deck_2024 slide show for hostingeriOncologi_Pitch Deck_2024 slide show for hostinger
iOncologi_Pitch Deck_2024 slide show for hostingerssuser9354ce
 
software-quality-assurance question paper 2023
software-quality-assurance question paper 2023software-quality-assurance question paper 2023
software-quality-assurance question paper 2023RohanMistry15
 
CloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlue
CloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlueCloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlue
CloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlueShapeBlue
 
MuleSoft Online Meetup Group - B2B Crash Course: PM Insider Lecture
MuleSoft Online Meetup Group - B2B Crash Course: PM Insider LectureMuleSoft Online Meetup Group - B2B Crash Course: PM Insider Lecture
MuleSoft Online Meetup Group - B2B Crash Course: PM Insider LectureManik S Magar
 
CloudStack Authentication Methods – Harikrishna Patnala, ShapeBlue
CloudStack Authentication Methods – Harikrishna Patnala, ShapeBlueCloudStack Authentication Methods – Harikrishna Patnala, ShapeBlue
CloudStack Authentication Methods – Harikrishna Patnala, ShapeBlueShapeBlue
 
Artificial Intelligence - AI For Everyone
Artificial Intelligence - AI For EveryoneArtificial Intelligence - AI For Everyone
Artificial Intelligence - AI For EveryoneSridhar Seshadri
 
Geospatial Synergy: Amplifying Efficiency with FME & Esri
Geospatial Synergy: Amplifying Efficiency with FME & EsriGeospatial Synergy: Amplifying Efficiency with FME & Esri
Geospatial Synergy: Amplifying Efficiency with FME & EsriSafe Software
 
What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...
What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...
What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...ShapeBlue
 
Mastering Play Store App Listing and Optimization
Mastering Play Store App Listing and OptimizationMastering Play Store App Listing and Optimization
Mastering Play Store App Listing and OptimizationAppsthentic Technology
 
National Institute of Standards and Technology (NIST) Cybersecurity Framework...
National Institute of Standards and Technology (NIST) Cybersecurity Framework...National Institute of Standards and Technology (NIST) Cybersecurity Framework...
National Institute of Standards and Technology (NIST) Cybersecurity Framework...MichaelBenis1
 

Recently uploaded (20)

Sue Loth: Job Search Strategies using personal connections
Sue Loth: Job Search Strategies using personal connectionsSue Loth: Job Search Strategies using personal connections
Sue Loth: Job Search Strategies using personal connections
 
Large Language Models and Applications in Healthcare
Large Language Models and Applications in HealthcareLarge Language Models and Applications in Healthcare
Large Language Models and Applications in Healthcare
 
VM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlue
VM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlueVM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlue
VM Migration from VMware to CloudStack and KVM – Suresh Anaparti, ShapeBlue
 
Trading Software Development_ Trends to Watch in 2024.pdf
Trading Software Development_ Trends to Watch in 2024.pdfTrading Software Development_ Trends to Watch in 2024.pdf
Trading Software Development_ Trends to Watch in 2024.pdf
 
AGFM - Toyota Coaster 1HZ Install Guide.pdf
AGFM - Toyota Coaster 1HZ Install Guide.pdfAGFM - Toyota Coaster 1HZ Install Guide.pdf
AGFM - Toyota Coaster 1HZ Install Guide.pdf
 
Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...
Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...
Elevating Cloud Infrastructure with Object Storage, DRS, VM Scheduling, and D...
 
eXtended Reality(XR) Basic introductions
eXtended Reality(XR) Basic introductionseXtended Reality(XR) Basic introductions
eXtended Reality(XR) Basic introductions
 
Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)
Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)
Leonis Insights: The State of AI (7 trends for 2023 and 7 predictions for 2024)
 
Q4 2023 Quarterly Investor Presentation - FINAL.pdf
Q4 2023 Quarterly Investor Presentation - FINAL.pdfQ4 2023 Quarterly Investor Presentation - FINAL.pdf
Q4 2023 Quarterly Investor Presentation - FINAL.pdf
 
TrustArc Webinar - TrustArc's Latest AI Innovations
TrustArc Webinar - TrustArc's Latest AI InnovationsTrustArc Webinar - TrustArc's Latest AI Innovations
TrustArc Webinar - TrustArc's Latest AI Innovations
 
iOncologi_Pitch Deck_2024 slide show for hostinger
iOncologi_Pitch Deck_2024 slide show for hostingeriOncologi_Pitch Deck_2024 slide show for hostinger
iOncologi_Pitch Deck_2024 slide show for hostinger
 
software-quality-assurance question paper 2023
software-quality-assurance question paper 2023software-quality-assurance question paper 2023
software-quality-assurance question paper 2023
 
CloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlue
CloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlueCloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlue
CloudStack Tooling Ecosystem – Kiran Chavala, ShapeBlue
 
MuleSoft Online Meetup Group - B2B Crash Course: PM Insider Lecture
MuleSoft Online Meetup Group - B2B Crash Course: PM Insider LectureMuleSoft Online Meetup Group - B2B Crash Course: PM Insider Lecture
MuleSoft Online Meetup Group - B2B Crash Course: PM Insider Lecture
 
CloudStack Authentication Methods – Harikrishna Patnala, ShapeBlue
CloudStack Authentication Methods – Harikrishna Patnala, ShapeBlueCloudStack Authentication Methods – Harikrishna Patnala, ShapeBlue
CloudStack Authentication Methods – Harikrishna Patnala, ShapeBlue
 
Artificial Intelligence - AI For Everyone
Artificial Intelligence - AI For EveryoneArtificial Intelligence - AI For Everyone
Artificial Intelligence - AI For Everyone
 
Geospatial Synergy: Amplifying Efficiency with FME & Esri
Geospatial Synergy: Amplifying Efficiency with FME & EsriGeospatial Synergy: Amplifying Efficiency with FME & Esri
Geospatial Synergy: Amplifying Efficiency with FME & Esri
 
What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...
What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...
What’s New in CloudStack 4.19, Abhishek Kumar, Release Manager Apache CloudSt...
 
Mastering Play Store App Listing and Optimization
Mastering Play Store App Listing and OptimizationMastering Play Store App Listing and Optimization
Mastering Play Store App Listing and Optimization
 
National Institute of Standards and Technology (NIST) Cybersecurity Framework...
National Institute of Standards and Technology (NIST) Cybersecurity Framework...National Institute of Standards and Technology (NIST) Cybersecurity Framework...
National Institute of Standards and Technology (NIST) Cybersecurity Framework...
 

PyCon Estonia: Contemporary Documentation