HelpNDoc’s feature tour - Advanced project analyzer

HelpNDoc's feature tour - Advanced project analyzer

Incredible documentation assistant HelpNDoc’s project analyzer checks and reports various useful information and possible problems with your help and manuals: feel confident providing the best possible documentation after checking with it. HelpNDoc’s project analyzer helps you review important project statistics, such as number of paragraphs, characters or links available throughout the documentation project. It displays a visual representation of the topic hierarchy for fast review. It also lists all hyperlinks in the project and can report broken links so that you will never produce a broken documentation file anymore.

Read More →

How to analyze your project

To access the Project Analyzer, click Analyze Project in the Project section on the Home ribbon tab. Then click Analyze in the lower left-hand corner to view project stats and other helpful information on four tabs. 1. General information This tab displays various information on your project and key statistics such as the number of: Topics Paragraphs Characters Hyperlinks Library items by type 2.

Read More →

How to analyze hyperlinks

To access the Project Analyzer, click Analyze Project in the Project section on the Home ribbon tab. Then click Analyze in the lower left-hand corner to view project stats and other helpful information. You can then click the Hyperlinks to review hyperlinks created in the current project. Hyperlink properties are displayed in multiple columns: Kind displays the type of the hyperlink Caption contains the words that readers click to activate the hyperlink Action displays the location readers are taken to when they click the hyperlink Extra provides supplemental information, as appropriate (e.

Read More →

How to analyze the items in your library

To access the Project Analyzer, click Analyze Project in the Project section on the Home ribbon tab. Then click Analyze in the lower left-hand corner to view project stats and other helpful information. You can then click the Library items tab to review library items in the current project. Each library item, its properties, and its usage are displayed in four columns: Kind displays the type of library item Caption is the name assigned to the item in the library Source refers to the way in which the library item is rendered.

Read More →

How to locate and fix broken hyperlinks in your user manuals, eBooks and help files

How to locate and fix broken hyperlinks in your user manuals, eBooks and help files
Categories: articles

Technical writers rely on hyperlinks to organize and reference multiple parts of their printed user manuals, eBooks or help files. Making sure hyperlinks are up to date is very important as broken hyperlinks can disrupt the learning flow of the end-user, who might be overwhelmed as she couldn’t find the information needed: this can lead to increased support costs if a support ticket is opened. Thankfully, the HelpNDoc help authoring tool includes a straightforward hyperlink analyzer to help technical writers quickly spot and fix problematic hyperlinks.

Read More →