aboutsummaryrefslogtreecommitdiff
path: root/documentation/research/documentation.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--documentation/research/documentation.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/documentation/research/documentation.md b/documentation/research/documentation.md
new file mode 100644
index 000000000..21f9a6107
--- /dev/null
+++ b/documentation/research/documentation.md
@@ -0,0 +1,75 @@
+# Diagram | Chart
+
+1. https://c4model.com/
+1. https://github.com/lukaslueg/macro_railroad
+1. https://bramp.github.io/js-sequence-diagrams/
+1. https://github.com/erikbrinkman/d3-dag
+1. https://dumptyd.github.io/treeflex/
+1. https://info.datalabsagency.com/blog/data-visualization-news/15-most-common-types-of-data-visualisation
+1. https://wettel.github.io/codecity.html
+1. http://quantifiedcode.github.io/code-is-beautiful/
+1. http://js.cytoscape.org/
+1. https://arcentry.com/
+1. https://bramp.github.io/js-sequence-diagrams/
+1. https://brokenbaysoftware.co/2018/12/18/Cumulative-Flow/
+1. https://frappe.io/gantt
+1. https://dbdiagram.io/home/
+1. https://ptsjs.org/
+1. https://blog.usejournal.com/bridging-the-gap-between-low-level-and-high-level-charting-libraries-a8f6c1819ba5
+1. https://www.infoq.com/articles/why-architectural-diagrams
+1. https://gramener.github.io/visual-vocabulary-vega/
+1. [Visually Representing the Landscape of Mathematical Structures](https://arxiv.org/abs/1809.05930)
+1. http://www.java2uml.com/s
+
+# Philosophy
+
+1. [Forget reusability, aim for perfection](https://www.openbsd.org/papers/bsdcan18-mandoc.pdf)
+1. https://increment.com/documentation/
+1. https://blog.stoplight.io/writing-documentation-when-you-arent-a-technical-writer-part-two-59997587cc2a
+
+# Explorability
+
+1. https://explorabl.es/jam/
+1. https://flowium.com/help.html
+1. https://apfelmus.nfshost.com/blog/2018/08/06-hyper-0-2.html
+
+# README
+
+1. https://github.com/LappleApple/feedmereadmes
+
+# Doclet
+
+1. https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html
+1. http://www.doclet.com/
+1. https://en.wikipedia.org/wiki/Doclet
+
+# Reference
+
+1. [Documenting the Clojure/Script Ecosystem – Martin Klepsch](https://www.youtube.com/watch?v=mWrvd6SE7Vg)
+1. http://apistylebook.com/
+1. https://docusaurus.io/
+1. https://gist.github.com/oakes/8db57ac808bf6ec144d627fd83a89da3
+1. https://github.com/oakes/Dynadoc
+1. https://github.com/bhauman/devcards
+1. https://kiwidocs.js.org/
+1. https://github.com/Microsoft/tsdoc
+1. https://github.com/PharkMillups/beautiful-docs
+1. http://lwm.github.io/posts/html/document-haskell.html
+1. http://lwm.github.io/texts/lets-write-documentation-for-haskell/
+1. https://groups.google.com/forum/#!msg/scala-internals/r2GnzCFc3TY/x3PmIq4cAgAJ
+1. http://naildrivin5.com/blog/2016/12/08/learn-graphviz-and-up-your-diagramming-game.html
+1. https://idyll-lang.github.io/
+1. http://docs.racket-lang.org/pollen/
+1. https://opensource.com/article/17/9/modular-documentation
+1. https://clojurecademy.github.io/dsl-documentation/#
+1. https://www.asyncapi.com/
+1. http://jupyter.org/
+1. https://medium.freecodecamp.org/how-to-build-interactive-presentations-with-jupyter-notebook-and-reveal-js-c7e24f4bd9c5
+1. https://github.com/stevekrouse/unbreakable-links
+1. https://www.divio.com/en/blog/documentation/
+1. https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart
+1. https://anbasile.github.io/programming/2015/12/25/hosting-reveal-pres-on-github/
+1. http://www.megacz.com/software/wix/
+1. https://github.com/documentationjs/documentation
+1. https://www.cockroachlabs.com/blog/go-file-size/
+