OntoDoc describes a (prospective) ontological
Although based in Elixir, it attempts to be language neutral.
The organization of the Elixir documentation reflects the structure of the code base.
So, for example, all of the functions in the
module are lumped together.
There are two problems with this:
- Related functions from other modules (e.g.,
Stream) are not shown.
- Cross-module categories of functions (e.g., Filter, Inspect) are not indexed.
It should be possible to create some ontological
using a combination of crowd-sourcing and appropriate tooling.
This could let users (for example) skim a list of categories,
looking for potentially relevant functions.
The Elixir environment provides a wealth of data sources for automated documentation.
These include generated files from Elixir, Erlang, and Phoenix,
as well as hand-edited files (e.g.,
See Data Sources
I hope to have more examples over time (:-).
As a quick hack, I wrote a script to generate the wiki markup for the lists above.
This wiki page is maintained by Rich Morin
an independent consultant specializing in software design, development, and documentation.
Please feel free to email
comments, inquiries, suggestions, etc!