- Home
- Documentation Generators
- Sandcastle Help File Builder
Sandcastle Help File Builder
What it is
Sandcastle Help File Builder (SHFB) creates help files for managed class libraries, including API references and conceptual topics. API reference topics draw on XML comments and the type syntax and structure in associated .NET assemblies. Authors can write conceptual material in Markdown or Microsoft Assistance Markup Language (MAML). SHFB offers a standalone GUI for editing compiled-help properties and managing project files, command-line tools for automated builds, a Visual Studio integration package, and MSBuild tasks. It accepts managed assemblies, XML comments, Visual Studio solutions and projects, Markdown, and MAML, and can produce HTML Help 1, MS Help Viewer, website, Open XML, and Markdown output. The current Visual Studio extension is for Visual Studio 2022 or later. Desktop tools and MSBuild builds require .NET Framework 4.8 or later; dotnet.exe builds require .NET 9.0 or later. HTML Help 1 output needs HTML Help Workshop, while MS Help Viewer files need Microsoft Help Library Viewer. SHFB is free, and the getting-started documentation links to guidance for GitHub workflow and Team Build.
For and against
For
- Free plan listed as free
- Conceptual topics support Markdown and MAML
- Offers GUI, command-line, Visual Studio, and MSBuild workflows
- Supports versioned documentation and CI/CD integration
Against
- Windows platform listed
- Requires .NET Framework 4.8 or later for desktop and MSBuild
- dotnet.exe builds require .NET 9.0 or later
- Some help outputs require separate Microsoft tools
The verdict
SHFB combines several authoring and build workflows for managed-library documentation. Check its .NET requirements and the extra tools required for certain output formats before choosing it.
Who it suits
SHFB suits developers documenting managed class libraries who want both API references and authored conceptual topics. It also fits teams building documentation through Visual Studio, command-line tools, or MSBuild.
Plans and prices
Sandcastle Help File Builder
Standalone GUI, command-line tools, Visual Studio integration package, MSBuild tasks
Read 7 Oct 2026 · github.com
On the record
- API documentation
- API reference topics combine source-code XML comments with type syntax and structure reflected from associated .NET assemblies.github.com · read 7 Oct 2026
- Automated builds
- The project includes command-line tools for building help files in an automated fashion.github.com · read 7 Oct 2026
- Build requirements
- The desktop tools and MSBuild builds require .NET Framework 4.8 or later, while builds with dotnet.exe require .NET 9.0 or later.ewsoftware.github.io · read 7 Oct 2026
- CI integration
- The getting-started documentation links to instructions for building with a GitHub workflow and Team Build.ewsoftware.github.io · read 7 Oct 2026
- Conceptual content
- Conceptual topics can be authored in Markdown or Microsoft Assistance Markup Language (MAML).github.com · read 7 Oct 2026
- GUI features
- The standalone GUI lets users edit compiled-help properties and manage files associated with a help project.ewsoftware.github.io · read 7 Oct 2026
- Installer
- The guided installer includes core components, the Visual Studio extension, and optional extras, and gives instructions for tools that cannot be distributed with it.github.com · read 7 Oct 2026
- Interfaces
- The project offers a standalone GUI, command-line tools, a Visual Studio integration package, and MSBuild tasks.github.com · read 7 Oct 2026
- Output dependencies
- Building HTML Help 1 files requires HTML Help Workshop, and Microsoft Help Viewer files require Microsoft Help Library Viewer.ewsoftware.github.io · read 7 Oct 2026
- Purpose
- SHFB provides tools for building help files for managed class libraries, including conceptual topics and API reference topics.github.com · read 7 Oct 2026
- Security
- The maker pages opened for this research provide no security or compliance claims.github.com · read 7 Oct 2026
- Support and project history
- The project README says Sandcastle development and support were merged into SHFB after Microsoft ceased Sandcastle development in October 2012.github.com · read 7 Oct 2026
- Supported editor version
- The current release includes the Visual Studio extension package for Visual Studio 2022 or later.github.com · read 7 Oct 2026
- Visual Studio integration
- A Visual Studio package lets users create and manage help projects within Visual Studio.github.com · read 7 Oct 2026
