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
440
(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
93
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
Introduce Hono CLI
yusukebe
6
3.1k
TFLintカスタムプラグインで始める Terraformコード品質管理
bells17
2
470
コードとあなたと私の距離 / The Distance Between Code, You, and I
hiro_y
0
200
The Past, Present, and Future of Enterprise Java
ivargrimstad
0
320
三者三様 宣言的UI
kkagurazaka
0
280
PHPに関数型の魂を宿す〜PHP 8.5 で実現する堅牢なコードとは〜 #phpcon_hiroshima / phpcon-hiroshima-2025
shogogg
1
340
Foundation Modelsを実装日本語学習アプリを作ってみた!
hypebeans
0
130
実践Claude Code:20の失敗から学ぶAIペアプログラミング
takedatakashi
18
9k
Domain-centric? Why Hexagonal, Onion, and Clean Architecture Are Answers to the Wrong Question
olivergierke
3
980
フロントエンド開発のためのブラウザ組み込みAI入門
masashi
7
3.6k
ALL CODE BASE ARE BELONG TO STUDY
uzulla
28
6.8k
AI 駆動開発におけるコミュニティと AWS CDK の価値
konokenj
5
280
Featured
See All Featured
The Art of Delivering Value - GDevCon NA Keynote
reverentgeek
16
1.7k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
4k
Building an army of robots
kneath
305
46k
The Myth of the Modular Monolith - Day 2 Keynote - Rails World 2024
eileencodes
26
3.1k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
37
2.6k
Embracing the Ebb and Flow
colly
88
4.9k
Designing for Performance
lara
610
69k
The Straight Up "How To Draw Better" Workshop
denniskardys
239
140k
Agile that works and the tools we love
rasmusluckow
331
21k
Rebuilding a faster, lazier Slack
samanthasiow
84
9.2k
What’s in a name? Adding method to the madness
productmarketing
PRO
24
3.7k
Context Engineering - Making Every Token Count
addyosmani
8
310
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