Documentation

ASCII Flowcharts

You can generate this:

Screen Shot 2016-04-22 at 11.59.58 PM

From this:

Screen Shot 2016-04-22 at 11.59.18 PM.png

But create it visually, by using this (http://asciiflow.com):

Screen Shot 2016-04-23 at 12.03.03 AM.png

The Java based tool that generates the bitmap image from the ASCII graph is called DITAA (DIagrams Through Ascii Art) (http://ditaa.sourceforge.net/).

I personally use the ditaa plugin for Dokuwiki this to embed flowchart diagrams into my Dokuwiki hosted documentation. Dokuwiki is a decently powerful wiki software similar to Mediawiki, etc. One major difference is that it uses flat files instead of an RDBMS. You can use either the flat file standard setup or the Git Backed plugin to have it as part of the SCM. Makes for much easier management and automatic documentation generation!

Screen Shot 2016-04-23 at 12.07.01 AM.png

 

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s