Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
(kick-ass) Readme Driven Development
Search
Floor Drees
October 18, 2014
Programming
3
430
(kick-ass) Readme Driven Development
as presented at DevFest Vienna 2014. Accompanying blog post will follow.
Floor Drees
October 18, 2014
Tweet
Share
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
140
Rails Girls Summer of Code 2014 lightning talk at RUG:B
floord
1
110
Kod.io Linz closing notes
floord
0
94
Gamification on CheckiO - Digitalista meetup Vienna
floord
0
91
WCEU recap and version control for content creators
floord
0
53
The best programmers are teachers
floord
2
110
Working towards great version control for WordPress
floord
1
6.1k
How to survive family gatherings and birthday parties as a Techie
floord
1
180
Rails Girls Bratislava
floord
4
100
Other Decks in Programming
See All in Programming
GitHub Actions × AWS OIDC連携の仕組みと経緯を理解する
ota1022
0
240
Swift Concurrency - 状態監視の罠
objectiveaudio
2
470
Go Conference 2025: Goで体感するMultipath TCP ― Go 1.24 時代の MPTCP Listener を理解する
takehaya
7
1.6k
CSC305 Lecture 04
javiergs
PRO
0
250
dynamic!
moro
9
6.7k
詳しくない分野でのVibe Codingで困ったことと学び/vibe-coding-in-unfamiliar-area
shibayu36
3
4.5k
CSC305 Lecture 02
javiergs
PRO
1
260
なぜあの開発者はDevRelに伴走し続けるのか / Why Does That Developer Keep Running Alongside DevRel?
nrslib
3
370
ててべんす独演会〜Flowの全てを語ります〜
tbsten
1
220
monorepo の Go テストをはやくした〜い!~最小の依存解決への道のり~ / faster-testing-of-monorepos
convto
2
410
Reduxモダナイズ 〜コードのモダン化を通して、将来のライブラリ移行に備える〜
pvcresin
2
690
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
160
Featured
See All Featured
A Tale of Four Properties
chriscoyier
160
23k
Embracing the Ebb and Flow
colly
88
4.8k
Fashionably flexible responsive web design (full day workshop)
malarkey
407
66k
Building Adaptive Systems
keathley
43
2.8k
Practical Tips for Bootstrapping Information Extraction Pipelines
honnibal
PRO
23
1.5k
StorybookのUI Testing Handbookを読んだ
zakiyama
31
6.2k
Helping Users Find Their Own Way: Creating Modern Search Experiences
danielanewman
30
2.9k
Bootstrapping a Software Product
garrettdimon
PRO
307
110k
We Have a Design System, Now What?
morganepeng
53
7.8k
Building Flexible Design Systems
yeseniaperezcruz
329
39k
The Invisible Side of Design
smashingmag
301
51k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
PRO
188
55k
Transcript
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