Sandcastle simplified (building CHM help files for .Net documentation)

step 1: download sandcastle from one of these 2 locations:



step 2: Do a straightforward installation

step 3: in visual studio, right-click on your project -> properties -> build -> scroll down and check "XML documentation file"

step 4: build your project

step 5: Run SandcastleGUI, find this under:
C:\Program Files\Sandcastle\Examples\generic 
C:\Program Files (x86)\Sandcastle\Examples\generic    (or for 64bit apps)

step 6: Add your assembly (the dll file which is normally in your application's "bin\debug" folder)

step 7: Also add the XML file which should normally be in your application's "bin\debug" folder)

step 8: Pick any name for your project (I picked "MyTestProject")

step 9: Click "build"

step 10: Locate your project under: (simply just find it that you know where it is)
C:\Program Files\Sandcastle\Examples
C:\Program Files (x86)\Sandcastle\Examples   (64bit)

step 11: Open a command prompt by:
click "Start" -> "run"  and type "cmd" <enter>

step 12: change your directory to where your product output reside:
(e.g. "cd  C:\Program Files\Sandcastle\Examples\MyTestProject\vs2005\chm" )
(where the "MyTestProject.hhc" file is located in my case)

step 13:  Convert the file:
"C:\Program Files\HTML Help Workshop\hhc.exe"  MyTestProject
"C:\Program Files (x86)\HTML Help Workshop\hhc.exe"  MyTestProject    (64 bit)

step 14: you should now have a MyTestProject.chm file

One Response to this post.

  1. Posted by LO on 01.03.10 at 4:38 pm

    Thanks for the guide

What's your thoughts on this?


Protected by WP Anti Spam