Technical Documentation with Visual Studio

If you want to generate accurate, MSDN style, comprehensive documentation by reflecting over the source assemblies and optionally integrating XML Documentation Comments, then you should use Sandcastle.

This might sound like an ad, but as you all might know i do not work for Sandcastle or Codeplex 🙂

But I was searching for some tools to automate the process of technical documentation of my projects and came across sandcastle, which I thought is a great Free tool.

  • Sandcastle is currently released on CodePlex (http://www.codeplex.com/Sandcastle).
  • Sandcastle is based on Microsoft’s internal tools that are used to build documentation for Visual Studioand the Microsoft .NET Framework.
  • Sandcastle is also bundled as an older community technology preview (CTP) with the Visual Studio 2005 and 2008 SDKs.
  • Sandcastle supports different presentation styles, including one that looks like the documentation for Visual Studio and the Microsoft .NET Framework.

Get Started:

Download the latest release, extract it to a folder, and then run SandcastleInstaller.exe to run the guided installation of Sandcastle and the various extra items from this project.

and you might want to download Sandcastle Styles Project which aims to improve Sandcastle by providing a rolled-up solution to various presentation style issues in a manner that is highly visible to the Sandcastle community and also involves community feedback.

Posted in Uncategorized