I started working with sandcastle to generate api documentation for the Asp.Net MVC - MvcContrib project (http://MvcContrib.org). I wanted to get some feedback as to how useful the general API Namespace/Class listings are. Below are two of the outputs of the documentation. I encourage you to take a quick look at it so that you can provide feedback.
To Subscribe to this RSS feed use this url: http://feeds.feedburner.com/EricHexter
Here is an html versions that the project could host online.
http://mvccontrib.googlecode.com/svn/trunk/Documentation/Help/Index.html
Here is a CHM help file. To view this you will need to Save As, than goto the file properties and click Unblock. If you do not unblock the file you will see the navigation tree, but all of the content will display a page not found error.
http://mvccontrib.googlecode.com/svn/trunk/Documentation/Help/MvcContrib-Api-Documentation.chm
Questions I need feedback on:
- Does having the Namespaces and classes browsable in this format provide and value as a user of the mvccontrib project?
- If all of the feature documentation from the CodePlex wiki was included in the help file would that make a difference to the value that this documentation provides? (The wiki docs are located here: http://www.codeplex.com/MVCContrib/Wiki/View.aspx?title=Documentation&referringTitle=Home)
- Is there a better way to provide general api documentation, do you have some examples of something you like?
Please provide feedback to this discussion thread. http://groups.google.com/group/mvccontrib-discuss/browse_thread/thread/34431f585a5da6c3