Freedom251 › Documentation Generators
Sandcastle Help File Builder
What Sandcastle Help File Builder is
Sandcastle Help File Builder (SHFB) provides tools for producing help documentation for managed class libraries. It creates API reference topics by combining XML comments from source code with type information and structure from related .NET assemblies. Authors can write conceptual topics in Markdown or Microsoft Assistance Markup Language (MAML). SHFB offers a standalone GUI for changing compiled-help properties and managing project files, command-line tools for automated builds, a Visual Studio package for managing projects, and MSBuild tasks. It accepts managed assemblies, XML comments, Visual Studio solutions and projects, Markdown, and MAML. Output formats include HTML Help 1, Microsoft Help Viewer, websites, Open XML, and Markdown. The project supports versioned documentation and CI/CD integration, with guidance for GitHub workflow and Team Build. SHFB is free. The Visual Studio extension supports Visual Studio 2022 or later. Desktop tools and MSBuild builds need .NET Framework 4.8 or later; builds using dotnet.exe need .NET 9.0 or later.
Who it suits
SHFB suits developers documenting managed class libraries who want API reference and conceptual topics in the same help project. Its GUI, command-line tools, Visual Studio package, and MSBuild tasks support different authoring and build workflows.
What it does well
- Combines API reference and conceptual documentation
- Supports Markdown and MAML topics
- Offers GUI, command-line, Visual Studio, and MSBuild tools
- Supports versioned documentation and CI/CD
- Free software
What to know first
- Desktop tools and MSBuild require .NET Framework 4.8 or later
- dotnet.exe builds require .NET 9.0 or later
- Some help outputs require separate Microsoft tools
Plans
| Plan | Billed and limits | Price |
|---|---|---|
| Sandcastle Help File Builder | Standalone GUI, command-line tools, Visual Studio integration package, MSBuild tasks | Free |
As github.com lists them, read 7 Oct 2026. The maker's own page has the final word.
Getting started
- Open the SHFB project website on GitHub.
- Use the guided installer to install core components and, if needed, the Visual Studio extension.
- Choose the GUI, command-line tools, Visual Studio integration, or MSBuild tasks for your project.
- Provide managed assemblies, XML comments, Visual Studio solutions or projects, Markdown, or MAML.
- Select an output format and meet its requirements, including any required Microsoft tools.
Verdict
SHFB provides several ways to create and build help for managed class libraries, with multiple input and output formats. Check its .NET requirements and the dependencies for the output format you need.
Questions
Is Sandcastle Help File Builder free?
Yes. The listed plan is free.
Which platforms does it support?
The listed platform is Windows.
What can it use as source input?
Inputs include managed assemblies, XML comments, Visual Studio solutions and projects, Markdown, and MAML.
What output formats are available?
It can produce HTML Help 1, Microsoft Help Viewer, websites, Open XML, and Markdown.
Which .NET versions are required?
Desktop tools and MSBuild builds require .NET Framework 4.8 or later. Builds with dotnet.exe require .NET 9.0 or later.
Does it need other tools to build help files?
HTML Help 1 output requires HTML Help Workshop, and Microsoft Help Viewer output requires Microsoft Help Library Viewer.
Facts from Sandcastle Help File Builder's own pages
- API documentation
- API reference topics combine source-code XML comments with type syntax and structure reflected from associated .NET assemblies. · github.com, 7 Oct 2026
- Automated builds
- The project includes command-line tools for building help files in an automated fashion. · github.com, 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, 7 Oct 2026
- CI integration
- The getting-started documentation links to instructions for building with a GitHub workflow and Team Build. · ewsoftware.github.io, 7 Oct 2026
- Conceptual content
- Conceptual topics can be authored in Markdown or Microsoft Assistance Markup Language (MAML). · github.com, 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, 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, 7 Oct 2026
- Interfaces
- The project offers a standalone GUI, command-line tools, a Visual Studio integration package, and MSBuild tasks. · github.com, 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, 7 Oct 2026
- Purpose
- SHFB provides tools for building help files for managed class libraries, including conceptual topics and API reference topics. · github.com, 7 Oct 2026
- Security
- The maker pages opened for this research provide no security or compliance claims. · github.com, 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, 7 Oct 2026
- Supported editor version
- The current release includes the Visual Studio extension package for Visual Studio 2022 or later. · github.com, 7 Oct 2026
- Visual Studio integration
- A Visual Studio package lets users create and manage help projects within Visual Studio. · github.com, 7 Oct 2026
Where Sandcastle Help File Builder stands on Freedom251
- Documentation Generators#26 of 37