blob: dec25e3d933403368636c5daa25724de4e31e3ca (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# Architecture
0. [ARCHITECTURE.md](https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html)
# Programming
0. [Skribilo: The Ultimate Document Programming Framework](https://www.nongnu.org/skribilo/)
# Diagram | Chart
0. https://c4model.com/
0. https://github.com/lukaslueg/macro_railroad
0. https://bramp.github.io/js-sequence-diagrams/
0. https://github.com/erikbrinkman/d3-dag
0. https://dumptyd.github.io/treeflex/
0. https://info.datalabsagency.com/blog/data-visualization-news/15-most-common-types-of-data-visualisation
0. https://wettel.github.io/codecity.html
0. http://quantifiedcode.github.io/code-is-beautiful/
0. http://js.cytoscape.org/
0. https://arcentry.com/
0. https://bramp.github.io/js-sequence-diagrams/
0. https://brokenbaysoftware.co/2018/12/18/Cumulative-Flow/
0. https://frappe.io/gantt
0. https://dbdiagram.io/home/
0. https://ptsjs.org/
0. https://blog.usejournal.com/bridging-the-gap-between-low-level-and-high-level-charting-libraries-a8f6c1819ba5
0. https://www.infoq.com/articles/why-architectural-diagrams
0. https://gramener.github.io/visual-vocabulary-vega/
0. [Visually Representing the Landscape of Mathematical Structures](https://arxiv.org/abs/1809.05930)
0. http://www.java2uml.com/s
# Philosophy
0. [Documentation as practical empathy](https://developerrelations.com/developer-experience/documentation-as-practical-empathy)
0. [What Makes Documentation Bad?](https://arunkprasad.com/log/what-makes-documentation-bad/)
0. [Forget reusability, aim for perfection](https://www.openbsd.org/papers/bsdcan18-mandoc.pdf)
0. https://increment.com/documentation/
0. https://blog.stoplight.io/writing-documentation-when-you-arent-a-technical-writer-part-two-59997587cc2a
# Explorability
0. [Code Hike](https://codehike.org/)
0. https://explorabl.es/jam/
0. https://flowium.com/help.html
0. https://apfelmus.nfshost.com/blog/2018/08/06-hyper-0-2.html
# README
0. https://github.com/LappleApple/feedmereadmes
# Doclet
0. https://docs.oracle.com/javase/8/docs/technotes/guides/javadoc/doclet/overview.html
0. http://www.doclet.com/
0. https://en.wikipedia.org/wiki/Doclet
# Reference
0. [Building a community of open-source documentation contributors](https://news.ycombinator.com/newest?next=31705868&n=1171)
0. [Documentation in the Era of Concepts and Ranges - Christopher Di Bella & Sy Brand - CppCon 2021](https://www.youtube.com/watch?v=nm45t2fnUms)
0. [conventional: comments](https://conventionalcomments.org/)
0. [Architecture decision record (ADR)](https://github.com/joelparkerhenderson/architecture_decision_record)
0. [Seamless API Specification](https://github.com/seamlessapis/seamless/tree/master/domain)
0. [Pollen: the book is a program](https://docs.racket-lang.org/pollen/)
0. [Documenting the Clojure/Script Ecosystem – Martin Klepsch](https://www.youtube.com/watch?v=mWrvd6SE7Vg)
0. http://apistylebook.com/
0. https://docusaurus.io/
0. https://gist.github.com/oakes/8db57ac808bf6ec144d627fd83a89da3
0. https://github.com/oakes/Dynadoc
0. https://github.com/bhauman/devcards
0. https://kiwidocs.js.org/
0. https://github.com/Microsoft/tsdoc
0. https://github.com/PharkMillups/beautiful-docs
0. http://lwm.github.io/posts/html/document-haskell.html
0. http://lwm.github.io/texts/lets-write-documentation-for-haskell/
0. https://groups.google.com/forum/#!msg/scala-internals/r2GnzCFc3TY/x3PmIq4cAgAJ
0. http://naildrivin5.com/blog/2016/12/08/learn-graphviz-and-up-your-diagramming-game.html
0. https://idyll-lang.github.io/
0. https://opensource.com/article/17/9/modular-documentation
0. https://clojurecademy.github.io/dsl-documentation/#
0. https://www.asyncapi.com/
0. http://jupyter.org/
0. https://medium.freecodecamp.org/how-to-build-interactive-presentations-with-jupyter-notebook-and-reveal-js-c7e24f4bd9c5
0. https://github.com/stevekrouse/unbreakable-links
0. https://www.divio.com/en/blog/documentation/
0. https://github.com/Bogdan-Lyashenko/js-code-to-svg-flowchart
0. https://anbasile.github.io/programming/2015/12/25/hosting-reveal-pres-on-github/
0. http://www.megacz.com/software/wix/
0. https://github.com/documentationjs/documentation
0. https://www.cockroachlabs.com/blog/go-file-size/
|
