Giter Club home page Giter Club logo

flow-design-cheatsheet's Introduction

Flow-Design Cheat Sheet

Writing clean code sounds as if you should write code in a certain way. That's certainly true. But what is also true is that writing code is only the last phase of a multi-step process called software development. How clean code is thus does not only depend on some coding techniques or pretty printing rules but starts much earlier. For us at the Clean Code Developer School it's firstly a matter of how you think about a solution what makes and keeps your code clean.

After first teaching "raw" principles and practices of clean coding in a pretty standard way we developed a more conceptual and more comprehensive method. This method we're calling Flow-Design (FD) and it's an eclectic approach to software development inspired by many sources.

At the heart of FD is a visual notation to enable developers to express their mental models of how they think requirements could be met. This visual language is deliberately kept very simple. It should not require extensive studying or special tools to be used. It's for "quick and dirty" sketches on flipcharts and whiteboards to be used by single developers or small teams. Its primary use is before code is written. It's a design tool, not (!) a documentation tool.

When applied in day to day business common flow designs look like this:

Exhibit 1

Exhibit 2

Exhibit 3

Consider them "graphic recordings" of collective thought processes. As such they need not be readily understandable for an outside person. The primary purpose is to develop shared understanding of a solution among participants in a design session - and guide them during the actual coding.

This claim of course requires Flow-Design to be clear about the notational elements, how to use them in conjunction, and also how to translate them into code.

If you're interested if Flow-Design lives up to this claim, check out the wiki of this repository. It provides a reference to the Flow-Design visual notation and how to derive real code from "bubbles".

flow-design-cheatsheet's People

Contributors

ccdschool avatar ralfw avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.