HelpNDoc User Manual

Tool name

What it does

Typical use

Example prompt

get_project_info

Reads basic information about the currently opened project, such as title, file path, author, summary, version, language, charset, and default topic ID.

Let the AI understand the project before suggesting structural or editorial changes.

Read the current project's info and suggest a shorter, clearer summary for the help file.

get_topic_list

Returns the list of all topics with IDs, captions, help IDs, help context, kind, order, visibility, and parent topic IDs.

Review the table of contents, identify gaps, or plan reorganizations.

List all topics and suggest which sections are missing for a complete getting-started path.

get_topic_info

Reads the full details of a specific topic, including metadata and content as Markdown.

Review, rewrite, or extend a specific topic while staying consistent with project context.

Get the details of topic getting_started and rewrite its introduction for beginners.

get_current_topic_info

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

Work on the topic the user is actively editing without asking for its ID.

Read the current topic and suggest a better caption plus a clearer opening paragraph.

get_current_selected_topic_ids

Returns the IDs of the topics currently selected in the table of contents.

Prepare batch operations on the current multi-selection.

Get the selected topic IDs so we can apply the same status to all of them.

create_topic

Creates a new topic with a caption, Markdown content, and an optional parent topic.

Add new sections or child topics generated by the AI.

Create a new child topic under installation called Troubleshooting and draft concise troubleshooting content in Markdown.

move_topic_tree

Moves an existing topic and its child topic tree to a new position using the available topic attach modes.

Reorganize the table of contents without recreating topics.

Move topic faq before topic release_notes.

manage_topic_header_footer

Gets or updates a topic's header and footer settings, including kind, stored text, and effective calculated text.

Review or standardize header/footer presentation for selected topics.

Get the header and footer settings for topic api_reference, then set the header to custom text and hide the footer.

manage_topic_system_properties

Gets or updates topic system properties such as icon index, visibility, description, help ID, help context, aliases, and page-break-before.

Adjust per-topic metadata or prepare a topic for output and navigation.

Set the description, aliases, and page-break-before flag for topic printing_guide.

get_keyword_list

Returns all keywords with their IDs, captions, and parent keyword IDs.

Understand the keyword hierarchy or spot missing concepts.

List all keywords and suggest any duplicates or missing top-level concepts.

get_keyword_info

Reads details about a specific keyword.

Check how a keyword is named and where it sits in the hierarchy.

Show me the details of keyword shortcuts and tell me whether it should be nested under another keyword.

create_keyword

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

Extend the keyword index from existing topic content.

Create a keyword Installation and associate it with the main setup topics.

move_keyword_tree

Moves an existing keyword and its child keyword tree using the available keyword attach modes.

Reorganize the keyword hierarchy without recreating keywords.

Move keyword Advanced to become the first child of keyword Configuration.

get_keywords_associated_with_topic_id

Returns all keyword IDs associated with a given topic.

Review how a topic is indexed and detect missing or irrelevant keywords.

List the keywords associated with topic user_interface and suggest any missing ones.

get_topics_associated_with_keyword_id

Returns the topic IDs associated with a given keyword.

Review how a keyword is used across the project.

Show all topics linked to keyword installation and tell me whether the keyword is too broad.

associate_topic_with_keyword

Links an existing topic to an existing keyword.

Improve keyword indexing for findability.

Associate topic first_steps with keyword Getting Started.

dissociate_topic_from_keyword

Removes the association between an existing topic and keyword.

Clean up incorrect or outdated keyword links.

Remove the association between topic whats_new and keyword backup_tool.

manage_tags

Manages project tags through one tool. Supports listing tags, getting one tag, creating a custom tag, and deleting a custom tag.

Inspect or maintain the project tag catalog while respecting system tags.

List all custom tags, then create a new tag called customer_portal.

manage_topic_tag_associations

Manages associations between topics and tags. Supports listing tags for a topic, listing topics for a tag, checking an association, associating, dissociating, and dissociating all for a topic or tag.

Classify topics with tags or clean up tag relationships in batches.

List the tags for topic deployment, then associate it with tag pdf.

manage_status

Manages project statuses through one tool. Supports listing, getting, creating, updating, and moving statuses.

Maintain the project's review or publication workflow labels.

List all statuses, then create a status called Ready for QA with a green color.

assign_status_to_topic

Assigns an existing status to a specific topic.

Mark a topic's editorial or publication state.

Assign status approved to topic getting_started.