Concept maps
This is one attempt to document Rabble Rouser's domain language. We're using a tool called concept maps. Concept maps only document the language we use and the relationship between concepts, they are not meant to describe behaviour of a system. Concept maps can help us ensure we all have the same understanding of the fundamental concepts in our domain.
The Rabble Rouser concept map will hopefully be useful when learning about the project, or introducing others to it.
To update the concept map, you'll need Graphviz installed. Graphviz is a command line tool for drawing graphs. We're using the DOT language to describe our concepts. Concepts look like:
member -> organisation [label=" joins "]
Formatting graphs using graphviz can be bit painful, so to keep it simple, concepts are nodes linked with an arrow ->, and we name the edge that represents the relationship with a label [label=" some label "] (with a space on either side of the label text to ensure the output is a bit more legible).
To rebuild the graph, try running:
dot -Tpng concept_map.gv -o concept_map.png
If you make changes to the concept map, please commit the updated graphviz document and output.