HelpNDoc User Manual

Tool name

What it does

Typical use

Example prompt

get_project_info

Reads basic information about the currently opened project (title, file path, author, summary, version, language, default topic ID…).

Let the AI understand the context of the project before making suggestions.

• First read the project information and then suggest a short, consistent summary and target audience for this help file.
• Read the current project's info and propose a short, marketing-friendly project summary based on its title and existing description.

get_topic_list

Returns the list of all topics (ID, caption, kind, order, visibility, parent ID…).

Get an overview of the table of contents, detect gaps or duplicates.

• List all topics in this project and tell me which areas of the documentation seem incomplete.
• List all topics and group them into logical sections (Getting Started, Configuration, Advanced, Troubleshooting). Show me any topics that don’t seem to fit anywhere.
• Analyze the topic list and suggest three new topics that would improve the overall documentation coverage.

get_topic_info

Reads full details of a specific topic, including its content, description, help ID, etc.

Review, rewrite, or extend a specific topic while staying consistent with existing content.

• Fetch the information and content of topic with help context 9 and rewrite it to be clearer for beginners.
• Get the details and content of topic "Getting started" and rewrite it as a step-by-step tutorial with clear headings and bullet points.

get_current_topic_info

Reads details and content of the topic currently selected in HelpNDoc.

Work directly on the topic the user is editing, without needing its ID.

• Read the currently selected topic and improve the introduction while keeping the same technical level.
• Read the currently selected topic and: 1) summarize it in three sentences, 2) suggest a more descriptive caption.
• Based on the current topic’s content, add a short "See also" paragraph at the end that references other relevant topics in the project.

create_topic

Creates a new topic in the table of contents with a caption, content, and optional parent topic.

Automatically add new sections or sub-sections based on AI suggestions.

• Create a new child topic under the current one called "Troubleshooting" and generate content explaining the most common issues and fixes.
• Create a new topic titled "FAQ" at the end of the table of contents and generate content with 10 frequently asked questions and answers about this product
• Under the currently selected topic, create a child topic called "Examples" and fill it with two practical code examples.

get_keyword_list

Returns all keywords (ID, caption, parent ID).

Understand the project’s keyword structure and identify missing keywords.

• List all existing keywords and tell me which major concepts are missing based on the topics in this project
• Retrieve the full keyword list and identify any near-duplicate keywords (for example singular vs plural) that should be merged or cleaned up.
• Based on the existing keywords, suggest a better hierarchical structure (parents/children) that makes navigation more intuitive.

get_keyword_info

Reads details about a specific keyword (caption, parent keyword).

Check whether a keyword is correctly named and placed in the hierarchy.

• Show the details of keyword "Quick Start" and suggest a clearer caption if needed.
• Inspect keyword "User interface" and suggest whether it should have a parent keyword to better fit the existing hierarchy.

create_keyword

Creates a new keyword, optionally with a parent keyword and associated topic.

Build or extend the keyword index automatically based on project content.

• Create a keyword "Getting started" and associate it with all introductory topics you find in the project.
• Create a keyword named "Shortcuts" under the parent keyword "Keyboard" and associate it with all topics that describe keyboard shortcuts.
• Add a top-level keyword ‘Installation’ and link it to all topics that explain how to install or update the product.

get_keywords_associated_with_topic_id

Returns all keywords linked to a given topic.

See how a topic is indexed; detect missing or redundant keywords.

• For topic "User interface", list the associated keywords and suggest any additional keywords that would improve searchability.
• Check the keywords attached to topic "AI" and tell me if any of them are irrelevant based on the topic’s content.

get_topics_associated_with_keyword_id

Returns topics associated with a given keyword.

Understand how a keyword is used across the project; spot over/under-used keywords.

• For keyword "User interface", list the associated topics and tell me if this keyword is too broad or too narrow.
• For keyword "Keyboard shortcut", list the associated topics and identify which important topics should also be linked to this keyword but currently are not.
• Show me all topics linked to keyword "Tools" and suggest whether this keyword should be split into more specific keywords.

associate_topic_with_keyword

Links an existing topic to an existing keyword.

Improve project classification by indexing topics under appropriate keywords.

• For each topic that explains installation steps, associate it with keyword "Installation" to improve the index.

dissociate_topic_from_keyword

Removes the association between a topic and a keyword.

Clean up incorrect or obsolete keyword associations.

• Remove the association between topic "What's new" and keyword "External backup tool" because that topic is no longer related to that keyword.
• Find topics associated with keyword "Troubleshooting" that are clearly unrelated and remove those associations to clean up the index.