Readme Driven Development

ReadmeDrivenDevelopment.md

Readme Driven Development

Problem

Build software that helps people.

Solution

Write your Readme first.

Readme

• Must not be complete.
• Designed to be read by the user.

Examples

• https://github.com/stefanbirkner/picover
• https://github.com/stefanbirkner/sfb-propertyeditors/blob/master/README
• https://github.com/stefanbirkner/system-rules/blob/master/src/main/java/org/junit/contrib/java/lang/system/RestoreSystemProperties.java
• http://stefanbirkner.github.io/system-rules
• https://github.com/stefanbirkner/vallado/blob/master/src/main/java/org/junit/contrib/java/lang/throwable/When.java

You get

• documentation (nicer than afterwards)
• a chance to think about the software
• guideline for the implementation
• describe the interface. others could start working
• basis for discussion
• no limits for your ideas - paper and brain