Skip to content

Instantly share code, notes, and snippets.

@stefanbirkner

stefanbirkner/ReadmeDrivenDevelopment.md

Created May 26, 2014 16:46
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save stefanbirkner/835b7d0c498b4026f65a to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save stefanbirkner/835b7d0c498b4026f65a to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. stefanbirkner revised this gist May 26, 2014. 1 changed file with 16 additions and 5 deletions.
    21 changes: 16 additions & 5 deletions ReadmeDrivenDevelopment.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,22 +1,33 @@
    Readme Driven Development
    =========================

    Problem: Build software that helps people.
    Problem
    -------

    Solution: Write your Readme first.
    Build software that helps people.

    Solution
    --------

    Write your Readme first.

    Readme
    ------

    Readme:
    * Must not be complete.
    * Designed to be read by the user.

    Examples:
    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:
    You get
    -------
    * documentation (nicer than afterwards)
    * a chance to think about the software
    * guideline for the implementation
  2. stefanbirkner created this gist May 26, 2014.
    27 changes: 27 additions & 0 deletions ReadmeDrivenDevelopment.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,27 @@
    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