Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Select an option

  • Save devashishdxt/fb25aae9fc300660932defe7f2663249 to your computer and use it in GitHub Desktop.

Select an option

Save devashishdxt/fb25aae9fc300660932defe7f2663249 to your computer and use it in GitHub Desktop.

Revisions

  1. @rodneyrehm rodneyrehm revised this gist Aug 20, 2014. 1 changed file with 5 additions and 1 deletion.
    6 changes: 5 additions & 1 deletion gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -1,4 +1,3 @@

    some tools for diagrams in software documentation

    ## Diagrams For Documentation
    @@ -39,4 +38,9 @@ yUML (ruby on rails) can be hosted yourself, for 49 USD

    ![Example Diagram](http://yuml.me/diagram/plain/class/%252F%252F%20Cool%20Class%20Diagram,%20%5BCustomer%7C-forname:string;surname:string%7CdoShiz()%5D%3C%3E-orders*%3E%5BOrder%5D,%20%5BOrder%5D++-0..*%3E%5BLineItem%5D,%20%5BOrder%5D-%5Bnote:Aggregate%20root%7Bbg:wheat%7D%5D.png)

    ---

    ![Dalek Class](http://yuml.me/diagram/plain;dir:LR;scale:80/class/,%20%5BCLI%5D%20-%3E%20%5BConfig%5D,%20%5BConfig%5D-%3E%5BDalek%5D,%20%5BDalek%5D-%3E%5BDalek%20load()%5D,%20%5BDalek%20load()%5D--%3E%5BDalek%20start()%5D.png)
    ![Dalek Sequence](http://yuml.me/diagram/plain/activity/(start)-%3E(CLI)-%3E(Config)-%3E(Dalek)-%3E(Dalek.load)-%3E(end).png)

    ---
  2. @rodneyrehm rodneyrehm created this gist Aug 20, 2014.
    42 changes: 42 additions & 0 deletions gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,42 @@

    some tools for diagrams in software documentation

    ## Diagrams For Documentation

    ### Obvious Choices

    * [Graphviz](http://www.graphviz.org/)
    * [Pandoc](http://johnmacfarlane.net/pandoc/)

    ### ASCII

    * [AsciiFlow Editor](http://asciiflow.com/) online web-editor, limited shapes
    * [Ditaa Generator](http://ditaa.sourceforge.net/) Java
    * [Ascidia Generator](https://github.com/Frimkron/Ascidia) Python


    ### UML

    * [Class Diagram - yUML](http://yuml.me/diagram/class/draw/samples)
    * [Activity Diagram - yUML](http://yuml.me/diagram/activity/samples)
    * [Use Case Diagram - yUML](http://yuml.me/diagram/usecase/samples)

    yUML (ruby on rails) can be hosted yourself, for 49 USD

    * [Sequence Diagram - js-sequence-diagrams](http://bramp.github.io/js-sequence-diagrams/) JavaScript, browser, SVG
    * [Sequence Diagram - flowchart.js](http://adrai.github.io/flowchart.js/) JavaScript, browser, SVG

    ### Sequence Diagrams

    * [KangaModeling](http://kangamodeling.org/), dot-like, web-api-renderer, .NET


    ###

    * https://stackedit.io/

    ---

    ![Example Diagram](http://yuml.me/diagram/plain/class/%252F%252F%20Cool%20Class%20Diagram,%20%5BCustomer%7C-forname:string;surname:string%7CdoShiz()%5D%3C%3E-orders*%3E%5BOrder%5D,%20%5BOrder%5D++-0..*%3E%5BLineItem%5D,%20%5BOrder%5D-%5Bnote:Aggregate%20root%7Bbg:wheat%7D%5D.png)

    ---