Generating documentation
Once your content is ready, HelpNDoc lets you generate documentation in a wide range of output formats.
- Select the Home ribbon tab if it is not already active.
- In the Project section, click the bottom of the Generate help button (where the bottom arrow is located).
- Choose the documentation format you want to generate.
- Click it to produce the output files.
Understanding the Generate Help Button
The Generate help button is split into two parts:
- Top part – Generate documentation dialog
Clicking the top portion opens the Generate documentation dialog. This dialog allows you to select the output format and extensively customize the generated documentation, including template, settings, conditional content, and many other options. - Bottom part – Quick generation menu
Clicking the lower portion displays a popup menu listing the documentation formats supported by HelpNDoc. Selecting a format from this menu immediately generates the documentation using the current settings, making it ideal for quick previews and frequent builds.
Now What?
After generating your documentation, you may want to explore more advanced features to refine and publish your work. The following topics are good next steps:
- Writing documentation – Learn best practices for structuring and authoring content.
- Publishing documentation – Discover how to distribute and deploy your generated output.
- Advanced usages – Explore powerful features for complex documentation projects.
- FAQ and troubleshooting – Find answers to common questions and solutions to typical issues.
These resources will help you get the most out of HelpNDoc as your documentation grows.
See also the How to publish your documentation step-by-step guide.