DataTables new documentation format is simply awesome.
DataTables new documentation format is simply awesome.
Your new documentation format is so good, I kind of want to reformat any documentation I've written for my own projects.
The Editor 1.2.2 release notes mention Editor has switched to semver. Perhaps you should write a documentation standard similar to semver for libraries. The new format accomplishes the holy grail of documentation:
1) Everything you need to actually use the feature you are reading about, with minimal context.
2) Nothing you don't need.
3) Non-distracting links to more detail, if desired. For example, I click on "sDom" in [code]"sDom": "Tfrtip"[/code] from a code example, and it actually takes me to the detailed documentation (which exists!) for sDom. I don't have to scan through tables of bulk links or use a search tool.
The Editor 1.2.2 release notes mention Editor has switched to semver. Perhaps you should write a documentation standard similar to semver for libraries. The new format accomplishes the holy grail of documentation:
1) Everything you need to actually use the feature you are reading about, with minimal context.
2) Nothing you don't need.
3) Non-distracting links to more detail, if desired. For example, I click on "sDom" in [code]"sDom": "Tfrtip"[/code] from a code example, and it actually takes me to the detailed documentation (which exists!) for sDom. I don't have to scan through tables of bulk links or use a search tool.
This discussion has been closed.
Replies
Personally I think solid documentation is the corner stone of any software library - open source or otherwise. As part of the DataTables 1.10 work I'm going to be introducing new documentation to this site, and the updated template will of course be used for offline documentation if you need it as well.
Regards,
Allan