Feedback Edit

Custom Help Toolkit

  • Article
  • 2 minutes to read

Microsoft has published a GitHub repository with scripts and tools that can help you prepare customized Help for your Business Central solution. This Help content can then be accessed from the user interface through the Learn more links as described in Configure Context-Sensitive Help. You are welcome to use any tools or processes to build and deploy content; this toolkit is intended to help you in some of the steps that are required.

Tip

You are not required to use the toolkit. It's available for you to use if it makes sense for your Business Central solution.

For example, if you deploy Business Central on-premises, you might want to set up a dedicated website with customer-specific content that includes customized content from Microsoft. The toolkit can help with that.

If your solution extends Business Central online with additional capabilities, you might want to just set up a website with your own content. In this case, you can use the toolkit to help you build the HTML files, or you can use other tools.

The GitHub repository includes source code for the tools, and we welcome contributions and feedback to collaborate on improving the toolkit.

Tools in the toolkit

The toolkit is available at https://github.com/microsoft/dynamics365smb-custom-help. The repo contains the following tools as well as the source code for the tools:

Custom Help

Depending on your solution, you are expected to deploy Help to a website that can be accessed by users of your solution. For more information, see User Assistance Model and Configuring the Help Experience. The toolkit is especially useful if you customize Microsoft's content the same way that you customize Microsoft's code, and if you deploy a customer-specific solution that is based on Microsoft's base application. If your solution extends Business Central online with additional capabilities, you might want to just set up a website with your own content. In this case, you can use the toolkit to help you build the HTML files, or you can use other tools.

See also

Configure Context-Sensitive Help
User Assistance Model
Migrate Legacy Help to the Dynamics 365 Business Central Format
Extend, Customize, and Collaborate on the Help for Dynamics 365 Business Central

Help us understand

We want to learn more about how people use Microsoft's custom Help toolkit. Take the survey (in English) and help us understand: https://forms.office.com/r/A4cUJgjkD1.