Documentation

releaseinfrastructuregit

Good documentation makes good software, not the other way round.

Mind-mapping

  • FreeMind, last stable 1.0.1 in April 2014 and a beta in 2016, so do not expect fixes.
  • Freeplane, the fork that kept going: 1.13.3 is the current stable and 1.13.4 is in pre-release.

Building documentation

  • Simplest thing : GitHub wiki & pages
  • As a service (installable version exists too) : Confluence
  • API doc as a service : ReadMe, the old readme.io now redirects there
  • Tool : Sphinx

Make it visual

  • Graphviz, diagrams described in a text file and laid out by the tool, released regularly (16.1.0 in the stable list).
  • Visio (well, I would avoid this one, but it’s still widely used)
  • ArgoUML, UML modelling. Last release 0.35.1, still the one built by the old Tigris infrastructure; the code moved to GitHub in 2019 and no release followed.
  • Dia, last tagged release 0.97.2 in 2011, plus an untagged 0.97.3 tarball published in 2014. The main branch, versioned 0.98.0, has moved to GTK 3 but has never been released, so distributions ship git snapshots rather than a stable release. The old GNOME wiki page for it is retired.

Related

Keyboard shortcuts

/Open search
CtrlKOpen search (Cmd+K on macOS)
?Show this cheat sheet
Ctrl/Show this cheat sheet (Cmd+/ on macOS)
EscClose search or this cheat sheet

Turns off the single-key shortcuts (/, ?). Ctrl/Cmd+K and Ctrl/Cmd+/ stay.