Onboard
Overview
Discovering how to integrate DocsHound involves initial steps such as navigating the onboarding flow, which includes URL scraping and the creation of a knowledge graph.
Onboarding Flow Details
Basic Inputs
After signing up for DocsHound, you'll be guided through an onboarding flow. This process helps DocsHound get to know your product better.
First, DocsHound asks for your product's URL. It uses this to collect data and start creating a knowledge graph specific to your application.
Next, you'll see your product's name, description, and functionalities already filled in. DocsHound pre-populates this information based on the data collected from your URL. Your job is to review and confirm these details are correct.
Screenshot Submission
After submitting a dashboard screenshot, DocsHound uses AI to analyze your user interface. This step helps DocsHound understand the layout and features of your application. It's an important part of setting up your documentation because it allows the software to provide more accurate and relevant content suggestions.
Mapping Features
Mapping operational tasks to application sections involves using DocsHound's guided table of contents builder. After submitting your application's screenshot, this feature helps you organize your content by linking what users can do in your app to specific areas or functions.
Get Your Feature Mapping Right
Accurate feature mapping is key to creating a dynamic table of contents that aligns with your app's layout and user interactions.
Post-Onboarding Actions
Table of Contents Creation
After submitting a screenshot and defining your main menu or app sections, the next steps involve finalizing your table of contents, updating your product information, and planning how your documentation will grow with your product. This ensures your support docs always match your current offerings.
Keep your documentation fresh and relevant by routinely checking and updating the product details. This may include descriptions, functionalities, and screenshots to ensure accuracy across all support materials.
As your product evolves, so should your documentation. Add new sections, update existing ones, and remove what's no longer relevant. This process keeps your users informed and helps them get the most out of your product.
Learn more about building out your table of contents via the add docs guide.
Frequently Asked Questions
If you encounter errors during the URL scrape, please double-check the URL for typos and ensure your site is accessible online. If the problem persists, reach out to our support team for help.
For screenshots, ensure your application's main menu is visible if it has one. The image should be clear and high-quality to help our AI analyze your user interface accurately.
To update the table of contents, navigate to the Table of Contents section in the Editor interface. From there, you can add, rename, or rearrange topics to reflect the most up-to-date structure of your documentation.
Yes, during onboarding, you'll be guided to map your application's features to the appropriate sections of your documentation. Follow the prompts to clearly associate features with their relevant documentation sections.