I find myself never writing documentation. This isn't because the tools don't exist, but rather because writing full-fledged Mathematica documentation is tedious with linking, example writing, overview page creation, etc.
I'm trying to come up with a more light-weight documentation structure that would cover 90% of use cases and that can be programmatically generated, assuming I have usage messages and can pull argument patterns out of
SubValues. I can currently replicate that built-in docs and push it to the web, but the problem is writing them is just too much of a hassle and I never do.
Does anyone have suggestions as to what they would like to see in a documentation format?
Here's an example:
Single Notebook Package Overview
I think for 60% of my use cases I really only need one
Notebook with a bunch of usage blocks like:
myFunc[arg1, arg2] does a thing arg1: Integer arg2: Integer myFunc2[args...] does another thing args: Integer sequence
And then these can link to more detailed pages on
myFunc2 that I can write up only for some small subset of my functions.