Reports - help-authoring-tool/helpinator-markdown GitHub Wiki

Reports

Reports allow you to get summary information about your project and save/print it.

Currently Helpinator has the following predefined reports:

  1. Topic titles and IDs . Shows topic titles and corresponding Context IDs to reference specific topics from your app. Useful for communication between a tech writer and a developer.
  2. Empty topics . Shows all empty topics in the project. Good to make sure all topics in your project have at least some text.
  3. Tasks by topics . To manage tasks assigned to topics.
  4. Project stats . Shows different project stats like number of topics, words and etc.
  5. Topic structure . Prints topic tree.

reports.png

reports1.png