EVERYTHING XIAOMI
Get listed

Sandcastle Help File Builder

Sandcastle Help File Builder (SHFB) creates help files for managed class libraries, combining API reference documentation with conceptual topics.

Place
#23 of 37
Score
5.9
Sandcastle Help File Builder's website

What Sandcastle Help File Builder is

Sandcastle Help File Builder (SHFB) creates help files for managed class libraries, combining API reference documentation with conceptual topics. Its API reference topics use XML comments from source code alongside type syntax and structure from associated .NET assemblies. Authors can write conceptual material in Markdown or Microsoft Assistance Markup Language (MAML). SHFB includes a standalone GUI for editing compiled-help properties and managing project files, command-line tools for automated builds, a Visual Studio package, and MSBuild tasks. The current Visual Studio extension supports Visual Studio 2022 or later. Inputs include managed assemblies, XML comments, Visual Studio solutions and projects, Markdown, and MAML; outputs include HTML Help 1, Microsoft Help Viewer, websites, Open XML, and Markdown. It supports versioned documentation and CI/CD integration, with guidance for GitHub workflow and Team Build. SHFB is free for Windows. Desktop tools and MSBuild builds require .NET Framework 4.8 or later, while dotnet.exe builds require .NET 9.0 or later. HTML Help 1 and Microsoft Help Viewer outputs also depend on separate Microsoft tools.

Good

  • Free Windows tool for managed-library documentation.
  • Combines XML comments with assembly type information.
  • Conceptual topics support Markdown and MAML.
  • Offers GUI, command-line, Visual Studio, and MSBuild tools.
  • Supports multiple help and document output formats.

Watch out

  • Desktop and MSBuild builds require .NET Framework 4.8 or later.
  • dotnet.exe builds require .NET 9.0 or later.
  • Some help outputs require separate Microsoft tools.

Who it suits

SHFB suits Windows developers documenting managed class libraries who want GUI, command-line, Visual Studio, or MSBuild workflows. It accepts both code-derived inputs and authored conceptual topics.

Verdict

SHFB covers API reference and conceptual help authoring, with several ways to build and manage projects. Check the .NET requirements and any separate output dependencies before choosing a build workflow.

Plans and prices

From Sandcastle Help File Builder's own pricing page, checked 7 Oct 2026.

All about pricing
PlanPriceWhat it gives you
Sandcastle Help File BuilderFreeStandalone GUI, command-line tools, Visual Studio integration package, MSBuild tasks

The facts

Each one read from Sandcastle Help File Builder's own pages, with the date it was checked.

What it does

API documentation
API reference topics combine source-code XML comments with type syntax and structure reflected from associated .NET assemblies.checked 7 Oct 2026
Automated builds
The project includes command-line tools for building help files in an automated fashion.checked 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.checked 7 Oct 2026
CI integration
The getting-started documentation links to instructions for building with a GitHub workflow and Team Build.checked 7 Oct 2026
Conceptual content
Conceptual topics can be authored in Markdown or Microsoft Assistance Markup Language (MAML).checked 7 Oct 2026
GUI features
The standalone GUI lets users edit compiled-help properties and manage files associated with a help project.checked 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.checked 7 Oct 2026
Interfaces
The project offers a standalone GUI, command-line tools, a Visual Studio integration package, and MSBuild tasks.checked 7 Oct 2026
Output dependencies
Building HTML Help 1 files requires HTML Help Workshop, and Microsoft Help Viewer files require Microsoft Help Library Viewer.checked 7 Oct 2026
Purpose
SHFB provides tools for building help files for managed class libraries, including conceptual topics and API reference topics.checked 7 Oct 2026
Security
The maker pages opened for this research provide no security or compliance claims.checked 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.checked 7 Oct 2026
Supported editor version
The current release includes the Visual Studio extension package for Visual Studio 2022 or later.checked 7 Oct 2026
Visual Studio integration
A Visual Studio package lets users create and manage help projects within Visual Studio.checked 7 Oct 2026

Alternatives to Sandcastle Help File Builder

All alternatives
  1. 1Scalar logo

    Scalar

    Free planOpen sourceWebAPILinuxmacOS
    8.4From $150 a month
    Visit
  2. 2Redocly logo

    Redocly

    WebAPIExtension
    7.0From $10 a month
    Visit
  3. 3Sphinx logo

    Sphinx

    Free planWebAPILinuxmacOS
    7.0Free plan
    Visit
  4. 4Asciidoctor logo

    Asciidoctor

    Free planWebAPIExtensionLinux
    6.9Free plan
    Visit
  5. 5

    JSON Schema for Humans

    Free planLinuxmacOSSelf-hostedWindows
    6.5Free plan
    Visit
  6. 6

    StepShot

    Free planmacOS
    6.5CN¥269 one-time
    Visit