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
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
AI駆動で0→1をやって見えた光と伸びしろ
passion0102
1
770
CSC305 Lecture 10
javiergs
PRO
0
220
タスクの特性や不確実性に応じた最適な作業スタイルの選択(ペアプロ・モブプロ・ソロプロ)と実践 / Optimal Work Style Selection: Pair, Mob, or Solo Programming.
honyanya
3
190
overlayPreferenceValue で実現する ピュア SwiftUI な AdMob ネイティブ広告
uhucream
0
200
Developer Joy - The New Paradigm
hollycummins
1
340
One Enishi After Another
snoozer05
PRO
0
150
チームの境界をブチ抜いていけ
tokai235
0
210
Android16 Migration Stories ~Building a Pattern for Android OS upgrades~
reoandroider
0
130
Go言語はstack overflowの夢を見るか?
logica0419
0
520
Google Opalで使える37のライブラリ
mickey_kubo
3
130
Vueのバリデーション、結局どれを選べばいい? ― 自作バリデーションの限界と、脱却までの道のり ― / Which Vue Validation Library Should We Really Use? The Limits of Self-Made Validation and How I Finally Moved On
neginasu
2
180
Reactive Thinking with Signals and the Resource API
manfredsteyer
PRO
0
100
Featured
See All Featured
Fantastic passwords and where to find them - at NoRuKo
philnash
52
3.5k
VelocityConf: Rendering Performance Case Studies
addyosmani
332
24k
Practical Orchestrator
shlominoach
190
11k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
285
14k
A Tale of Four Properties
chriscoyier
161
23k
Raft: Consensus for Rubyists
vanstee
140
7.2k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
37
2.6k
How GitHub (no longer) Works
holman
315
140k
The Cult of Friendly URLs
andyhume
79
6.6k
Java REST API Framework Comparison - PWX 2021
mraible
34
8.9k
No one is an island. Learnings from fostering a developers community.
thoeni
21
3.5k
Speed Design
sergeychernyshev
32
1.2k
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