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
330
(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
100
Rails Girls Summer of Code 2014 lightning talk at RUG:B
floord
1
110
Kod.io Linz closing notes
floord
0
86
Gamification on CheckiO - Digitalista meetup Vienna
floord
0
79
WCEU recap and version control for content creators
floord
0
47
The best programmers are teachers
floord
2
99
Working towards great version control for WordPress
floord
1
6k
How to survive family gatherings and birthday parties as a Techie
floord
1
170
Rails Girls Bratislava
floord
4
89
Other Decks in Programming
See All in Programming
Regular Expressions, REXML, Automata Learning
makenowjust
0
220
The Sequel to a Dream of Ruby Parser's Grammar
ydah
1
220
Scala におけるコンパイラエラーとの付き合い方
chencmd
2
430
Hermes: Better Performance with Bytecode Translation (React Universe 2024)
tmikov2023
0
100
Crafting Cross-Platform Adventures: Building a Game Engine with Kotlin Multiplatform
dwursteisen
0
220
Prolog入門
qnighy
4
1k
[DroidKaigi 2024] Android ViewからJetpack Composeへ 〜Jetpack Compose移行のすゝめ〜 / From Android View to Jetpack Compose: A Guide to Migration
syarihu
1
690
意外とフォントが大事だった話 / Font Issues on Internationalization
fumi23
0
110
LangGraphでのHuman-in-the-Loopの実装
os1ma
3
1.1k
Pythonで改めて考える「クラス(class)」の使いどころ
os1ma
7
1.5k
Prompt Cachingは本当に効果的なのか検証してみた.pdf
ttnyt8701
0
540
Some more adventure of Happy Eyeballs
coe401_
2
190
Featured
See All Featured
The Psychology of Web Performance [Beyond Tellerrand 2023]
tammyeverts
36
2.1k
10 Git Anti Patterns You Should be Aware of
lemiorhan
653
58k
Designing on Purpose - Digital PM Summit 2013
jponch
114
6.8k
Teambox: Starting and Learning
jrom
131
8.7k
Building Your Own Lightsaber
phodgson
101
6k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
123
18k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
36
1.7k
How GitHub (no longer) Works
holman
310
140k
The World Runs on Bad Software
bkeepers
PRO
64
11k
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
166
48k
4 Signs Your Business is Dying
shpigford
179
21k
The Power of CSS Pseudo Elements
geoffreycrofte
71
5.3k
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