MSDN style help file for Events
As member of the DNN reference team and as a creator of the DNN Core API MSDN help file, I have some experience in generating documentation based on code comments in the source.
I created a new Sandcastle Help file builder project to retrieve the documentation from the Events source files and generate a .chm MSDN style help file.
After generating the Events help file, I realised that not all parts of the module are documented to the level that we feel completely confident with. So you can expect better internal documentation and thus a better API help file in upcoming versions of Events.
Events Table documentation
In order to provide documentation about the tables used by Events, I used a tool (Redgate SQL doc) to create a Word document that lists all Events tables, indexes, keys, indexes, references, etc.
This is an experiment
I realize that this technical documentation might not be of interest to every Events user and that the documentation is primarily focussed towards the Developer and/or Web admins with SQL knowledge.
So, I consider this an experiment.
- If the download counters for these specific files reach serious numbers, I will continue to create the documentation for new versions of Events.
- If the download counter stays very low, I have “wasted” a good part of a Sunday evening on things people are not interested in.
Well, these things happen!
Please have a look at the Events download page on CodePlex.