This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2021-04-04
Channels
- # babashka (3)
- # beginners (103)
- # calva (2)
- # cljs-dev (4)
- # clojure (23)
- # clojure-europe (16)
- # clojure-germany (1)
- # clojuredesign-podcast (2)
- # clojurescript (5)
- # cursive (4)
- # datahike (1)
- # datascript (1)
- # depstar (13)
- # fulcro (5)
- # inf-clojure (18)
- # lsp (37)
- # meander (2)
- # nrepl (2)
- # off-topic (12)
- # releases (2)
- # rewrite-clj (2)
- # shadow-cljs (9)
- # tools-deps (26)
Which tools (Edit: software, workflows, notations) do you use to document your software visually? I’d like to document how data flows through my application and how it is transformed, as it becomes more and complex. Some parts of UML could be helpful, but it does not look like a dream team to me
I'm not sure whether it's an improvement over UML for your use case, but I've really grown to like Graphviz for things like that. I really like it that I don't actually have to draw anything, I can just type foo -> bar
into a text file and that's it.
I prefer documenting software right alongside code so that it's easier to keep them in sync. My current workflow is to use markdown paired custom renderers like mermaid-js for diagrams. https://mermaid-js.github.io/mermaid/#/ It covers most of the usual diagrams.
There's also PlantUML that integrates with Lein: https://github.com/vbauer/lein-plantuml and several editors e.g. IntelliJ IDEA, Eclipse, VSCode, Emacs etc. PlantUML is text-based UML, and relatively easier to keep with the source code.
pen and paper ?
I didn't do too much software documentation but throughout university http://draw.io was my friend for diagrams and visualisations
http://draw.io is a great tool, I agree 🙂
Do any of you use Google Sheets as a backend for your app? Is this a common practice? I am thinking about using a Google Sheet as a sync server for a todo app.
Not quite the same, but just last week I arrived to the (common) epiphany that I should start learning how to really use google sheets (data validation, automatising data input) because it’s the fastest way to get non-technical people at my company to give me sane data
They already use sheets, and so far I’ve build tools for them as clojurescript web apps. I think I would have saved myself a lot of time had I done it on sheets instead