Skip to content

Instantly share code, notes, and snippets.

@fdmysterious

fdmysterious/documentation-tools.md

Last active May 3, 2023 11:43
Show Gist options
  • Save fdmysterious/b1f3914058cf6761b926d9c0593a23ef to your computer and use it in GitHub Desktop.
Save fdmysterious/b1f3914058cf6761b926d9c0593a23ef to your computer and use it in GitHub Desktop.
Download ZIP
Documentation tools
Raw
documentation-tools.md

Dumb index of documentation tools

This is a personal list of some documentation tools that I find useful

Note taking

  • Obsidian : Note taking program using markdown. Has a bunch of extensions which can be versionnable in a git repo easily.

Documentation generators

  • Doxygen : Classic documentation generator from code comments.

Graphs

  • GraphViz : General purpose tool for diagrams. Simple syntax, but can give complex results. Can be coupled with python with the graphviz module for templatization.

Code architecture

  • PlantUML : Classic diagram tool for UML modelisation (class diagram, sequence diagram, use case diagram...)

  • Mermaid : Another javascript module for diagram generation. Can also generate Gantt diagrams. The tool is natively integrated in some tools like Gitlab. Can also be integrated in doxygen

Chronograms

  • WaveDrom : Draw timing dragrams with code.
  • AsciiWave : Turns Wavedrom files into ascii art timing diagrams.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment