Sync release notes [alpha]
Overview
Learn how to activate DocsHound's experimental Sync release notes feature that enables AI-automated updates to your product documentation at the click of a button.
Sync Process
Click the Sync Release Notes button at the top of your guide
Share email using email template below to hound@docshound.com
Include detailed information and screenshots
Follow sync process outlined below
Share back to Hound AI
You will receive an email notification when your guide has been updated
Keeping Your Product and Docs in Sync
Beta Feature Email Template
The Sync release notes feature will soon be available for customers on the Pro Plan. To sync your release notes, you will need to send an email to hound@docshound.com
Follow the template below for the email subject and body.
Use Your Company Email Account
Use your DocsHound authenticated email address, i.e. the account you use to login to DocsHound. Otherwise, the email will not be received, and your guide will not be updated. You won't receive any response in this case.
Email Template
[SUBJECT]
Athena Intelligence - Release Notes June 18, 2024
[BODY]
Release Notes:
– Sheets and reports are now available in Drive, see UpdatedDrive.png
– Users can create new reports and sheets using available templates, see UpdatedReports.png
– Improved syncing speed for large datasets.
– Added support for new data formats.Sync Workflow:
Step 1 – Respond to HoundAI feedback
You will be invited to a Google Doc that contains HoundAI comments on all sections and images that require an update.
On occasion, this may involve changes to the information architecture of your guide.
Within the interface, you have the option provide a response to each comment When complete, share the document back to sync.hound@docshound.com
Step 2 – Receive updated guide
Your guide will be updated in track changes with HoundAI's suggested revisions. You have the option to accept, delete, and rewrite sections yourself. Once complete, share the document back with commit.hound@docshound.com for your updates to be processed.
At this moment, each DocsHound user receives 1 complementary sync notes per month as we gather data to improve the offering.
End to end processing time can be achieved in a day, mostly dependent on the time it takes you to respond to comments in Step 1. Comments must be provided within the same month of receiving the update.
Tips
Attach Screenshots
Attach UI screenshots that complement your release notes and provide context. DocsHound uses vision to analyze the screenshots.
High quality screenshots that are 16:9 in resolution can also be used for your documentation.
In certain instances, Pro Plan users can take advantage of premium high resolution screenshots. Reach out via Slack if you are interested.
Be Detailed and Structured
To ensure smooth syncing, please provide as much detail as possible and structure your release notes clearly. Including screenshots can help clarify any changes or new features.
Be Detailed and Structured
When syncing release notes, include as much detail as possible and be organized. Add screenshots to help us understand the context better. DocsHound will share a Google Doc with suggested updates for your review.
Frequently Asked Questions
The beta phase is a testing period where the feature is shared with users to gather feedback and make improvements before the official launch.
To add screenshots, use the upload button or drag-and-drop images into the designated area in the DocsHound interface.
Updates are usually shared via a Google Doc. DocsHound aims to respond within a day, but it may take longer since this feature is still experimental.
You can sync your release notes once a month. If you need more frequent updates, please contact support.