Ask Your Docs - User Guide

Ask Your Docs User Guide

Validate your documentation with AI before publishing

Version 1.0 | ClickHelp Documentation Team | June 2025

## Overview Ask Your Docs is an AI-powered content validation tool that helps you identify gaps and unclear sections in your documentation before publication. By asking questions against your draft content, you can ensure your documentation addresses real user needs and provides clear, helpful answers.

Key Benefits

  • Early validation: Catch content gaps before readers encounter them
  • AI-powered insights: Get instant feedback on content clarity and completeness
  • Improved user experience: Create documentation that better serves your audience
  • Reduced support load: Address common questions proactively in your docs
## Prerequisites Before you can use Ask Your Docs, ensure the following requirements are met:
Requirement Description How to Check
Portal access Author or contributor permissions in ClickHelp You can create or edit content in projects
Feature availability Ask Your Docs included in your license Contact your account manager or check billing details
Admin activation Portal administrator has enabled AI features Ask Your Docs appears in left navigation
Content availability At least one project with draft or published content You have projects visible in your portal
## Getting Started ### Accessing Ask Your Docs
1
Open your ClickHelp portal
Sign in to your ClickHelp account and navigate to your portal.
2
Locate Ask Your Docs
In the left navigation panel, look for Ask Your Docs with a NEW badge.
3
Click to open the interface
Select the Ask Your Docs option to open the validation interface.

First-time users: If this is your first visit, you may see an introductory tour highlighting the Ask Your Docs button. Follow the prompts to learn about the feature.

### Understanding the Interface When you first open Ask Your Docs, you'll see: - **Welcome message** explaining the feature's purpose - **Question input field** with example placeholder text - **Usage counter** showing remaining daily questions - **Learning resources** linking to AnswerGenius information ## Using Ask Your Docs ### Asking Your First Question
1
Think of a user question
Consider what your readers typically ask about your product or service. Examples:
  • "How do I install the software?"
  • "What are the system requirements?"
  • "How do I troubleshoot connection issues?"
2
Enter your question
Type your question in the input field. Be specific and use natural language as if you were a real user.
3
Submit the question
Press Enter or click the submit button to send your question to the AI.
4
Review the response
The AI will analyze your content and provide an answer based on what it found in your documentation.
### Interpreting AI Responses Ask Your Docs provides different types of responses based on content quality:
Response Type Indicator What It Means Recommended Action
Confident Answer ✅ Positive phrases like "Your documentation addresses this clearly" Your content successfully answers the question No action needed; content is good
Uncertain Answer 🤔 Phrases like "Hmm, looks like your docs might need more detail" Content gap or unclear information detected Review and improve relevant content sections
No Answer Found ❓ Messages about missing information Question not addressed in current documentation Create new content or enhance existing sections
Technical Error ⚠️ Error messages about system issues Temporary service disruption Wait a moment and try again
### Best Practices for Effective Questions To get the most value from Ask Your Docs, follow these guidelines:

✓ Do This

  • Ask specific questions: "How do I reset my password?" instead of "Tell me about passwords"
  • Use realistic scenarios: Think about actual support tickets or user feedback
  • Test different phrasings: Users ask the same thing in different ways
  • Cover various topics: Test different sections of your documentation
  • Ask follow-up questions: Build on previous queries to test completeness

✗ Avoid This

  • Overly broad questions: "How does everything work?" won't provide useful insights
  • Internal jargon: Use terms your actual users would use
  • Yes/no questions: Open-ended questions reveal more about content quality
  • Testing the same thing repeatedly: Vary your questions to maximize learning
## Managing Your Usage ### Understanding Daily Limits Ask Your Docs includes usage limits to ensure optimal performance: - **Default limit:** 10 questions per day - **Limit resets:** Every 24 hours at midnight UTC - **Usage tracking:** Visible counter shows remaining questions

Important: Plan your questions strategically. Use them to test the most critical or problematic sections of your documentation first.

### Maximizing Your Question Allowance
1
Prioritize high-impact content
Focus on sections that receive the most user questions or support tickets.
2
Test new or updated content
Use Ask Your Docs to validate recently created or modified sections.
3
Vary your question types
Ask different kinds of questions: how-to, troubleshooting, conceptual, and procedural.
4
Document your findings
Keep notes about which sections need improvement based on AI responses.
## Improving Your Content ### Acting on AI Feedback When Ask Your Docs identifies content gaps:
1
Identify the specific issue
Review the AI response to understand what information is missing or unclear.
2
Locate relevant content sections
Find the documentation sections that should address the question.
3
Enhance or create content
Add missing information, clarify existing text, or create new sections as needed.
4
Test your improvements
Ask the same question again to verify the AI can now find a clear answer.
### Content Quality Indicators Look for these patterns in AI responses:
Pattern Likely Cause Solution
Vague or incomplete answers Information scattered across multiple sections Consolidate related information
Cannot find specific procedures Steps buried in long paragraphs Use numbered lists and clear headings
Mentions related but not exact topic Content exists but lacks specific keywords Add relevant terminology and synonyms
No relevant information found Topic not covered in documentation Create new content section
## Troubleshooting ### Common Issues and Solutions
Issue Possible Cause Solution
Ask Your Docs not visible Feature not enabled by administrator Contact your portal administrator
"Feature not available" message Not included in current license Contact account manager or sales team
Questions not working Temporary service issue Wait and try again; refresh page if needed
Unexpected answers AI analyzing published instead of draft content Verify you're testing the intended content version
Daily limit reached Used all available questions Wait 24 hours for limit reset
### Getting Help If you encounter persistent issues: 1. **Check system status:** Verify ClickHelp service status 2. **Clear browser cache:** Refresh the page completely 3. **Contact support:** Use the help system or submit a support ticket 4. **Consult your administrator:** For settings or permission issues
## Next Steps ### Exploring AnswerGenius Ask Your Docs is powered by the same technology behind AnswerGenius, our AI assistant for end users. If Ask Your Docs proves valuable for your content validation, consider: - **AnswerGenius for readers:** Provide 24/7 AI assistance to your documentation users - **Enhanced user experience:** Let users ask questions directly within your published content - **Reduced support tickets:** Enable self-service through intelligent content interaction **Learn more:** [Request AnswerGenius Demo →](#) ### Additional Resources - [ClickHelp AI Terms and Conditions](https://clickhelp.com/legal/ai-terms/) - [Content Writing Best Practices](#) - [Documentation Analytics and Insights](#) - [Publishing Workflow Guide](#)

Feedback welcome: Help us improve Ask Your Docs by sharing your experience and suggestions through the feedback system or support channels.

--- *Last updated: June 16, 2025 | Document version: 1.0 | Feature version: 1.0*