Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Sign up for free
Menu
Search
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Features
All features
Private URLs
Password Protection
Custom URLS
Scheduled publishing
Remove Branding
Restrict embedding
Deck Collections
Notes
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Explore
Featured decks
Featured speakers
Programming
Technology
Storyboards
Pricing
Search
Sign in
Sign up for free
(kick-ass) Readme Driven Development
Search
Floor Drees
October 18, 2014
Programming
500
3
Share
Embed
Copy iframe code
Copy JS code
Copy link
Start on current slide
(kick-ass) Readme Driven Development
as presented at DevFest Vienna 2014. Accompanying blog post will follow.
Floor Drees
October 18, 2014
Transcript
46 slides
kick-ass Documentation Driven Development @floordrees
kick-ass Documentation Driven Development although really we will be talking
about RDD @floordrees
readme documentation
None
None
None
back to the topic
We often only start writing documentation for our apps and
app functionality after we have developed them.
a vital part in the decision making process
coding ALL the rubies
nobody puts baby in a corner
Readme or Documentation Driven Development brings back the design-driven way
of thinking
what about BDD as Behaviour or Business Driven Development?
tl;dr
detecting complexity early on
pro tip:! write your issues like documentation
Until you've written about your software, you have no idea
what you’re doing.
A perfect implementation of the wrong specification is worthless. A
beautifully crafted library with no documentation is also damn near worthless. Tom Preston Werner
benefits of RDD
think through the project without the overhead of having to
change code every time you change your mind
you'll have a very nice piece of reference for what
will become your documentation
pro tip:! keep your Readme open at all times
Retroactively writing a Readme is an absolute drag.
your co-workers can confidently ! start work on other projects
that will interface with your code
free bonus feature:! no teams just sitting there, being pretty
it's a lot simpler to have a discussion based on
something written down
It has the ability to give a high level view
of your code with the goal to gather insight and recommendations from your consumers early and throughout the design process.
it’s markdown! you know markdown! you can do markdown
Github showcases the Readme on the main project page
it’s totally Open Source compatible
pro tip:! Looking to add RDD / DDD to your
existing project? It can be as simple as just adding a step to your BDD or TDD
pro tip:! make writing or updating documentation ! a required
first step of your ! development process
pro tip:! include documentation changes as part of your code
reviews
pitfalls of RDD
just an over-generalization of a good idea!
have the Readme present what you are aiming for, rather
than what the code actually does
a Readme does not substitute ! proper documentation
what makes a good Readme?
airbnb for cats
formatting is key
rrrrr code samples
community and licensing details
air your dirty laundry in public
OMG badges
Readmore: http://tom.preston-werner.com/2010/08/23/readme-driven-development.html http://collectiveidea.com/blog/archives/2014/04/21/on-documentation- driven-development/!
thank you @floordrees
More Decks by Floor Drees
See All by Floor Drees
What if you could code like a boss (/Rails Girl) all Summer long
floord
0
190
Rails Girls Summer of Code 2014 lightning talk at RUG:B
floord
1
140
Kod.io Linz closing notes
floord
0
120
Gamification on CheckiO - Digitalista meetup Vienna
floord
0
120
WCEU recap and version control for content creators
floord
0
82
The best programmers are teachers
floord
2
130
Working towards great version control for WordPress
floord
1
6.3k
How to survive family gatherings and birthday parties as a Techie
floord
1
220
Rails Girls Bratislava
floord
4
130
Other Decks in Programming
See All in Programming
自宅サーバはどこまで再現できるのか - Proxmox VE上のVM環境をIaCとバックアップで戻してみた
youto
0
440
느린 네트워크와 저사양 디바이스 사용자를 위한 웹뷰 로딩 시간 개선기
kmkim
1
270
Kotlin Fest 2026: Kotlin コンパイラに Contribute してみよう! - Kotlin/Wasm で深い再帰を書けるようにした話
ternbusty
1
400
DroidKnights 2026 Android A2UI Jetpack Compose 기반의 안전한 AI UI 렌더링 - 박제창
itsmedreamwalker
1
260
ローカルLLMの基本と近況 2611 / Local LLM basics and recent situation 2611
kishida
3
630
Apple Intelligenceとオンデバイス時代の到来
yahir0
0
250
テストだけで見つかる? Rubyでつくるメソッド発掘器
izawa
0
150
学びを記事・スライド・Xへ高速展開する― AI-assisted Learning Loopで回すコンテンツ生成術
ochtum
0
220
Goコンパイラを作ってGoをもっと理解する / Build a Go compiler to better understand Go
ikura_hamu
0
130
SODA - FACT BOOK(JP)
sodainc
1
40k
Crash Auto Pipelines
veronikapj
1
440
Augmenting AI with the Power of Jakarta EE
ivargrimstad
0
390
Featured
See All Featured
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
141
35k
Speed Design
sergeychernyshev
33
2.2k
Prompt Engineering for Job Search
mfonobong
0
590
Designing Dashboards & Data Visualisations in Web Apps
destraynor
232
55k
The Curious Case for Waylosing
cassininazir
1
620
How People are Using Generative and Agentic AI to Supercharge Their Products, Projects, Services and Value Streams Today
helenjbeal
2
400
SERP Conf. Vienna - Web Accessibility: Optimizing for Inclusivity and SEO
sarafernandez
2
1.7k
Building a A Zero-Code AI SEO Workflow
portentint
PRO
0
840
Six Lessons from altMBA
skipperchong
29
4.6k
Max Prin - Stacking Signals: How International SEO Comes Together (And Falls Apart)
techseoconnect
PRO
0
540
DBのスキルで生き残る技術 - AI時代におけるテーブル設計の勘所
soudai
PRO
68
60k
Documentation Writing (for coders)
carmenintech
77
5.6k