Help me document an existing Hubspot can for agent users
- User
Help me document an existing Hubspot can for agent users
- Assistant
Documenting an existing HubSpot CAN (Customer Agent Navigation) for agent users involves creating clear, concise, and actionable documentation that helps agents understand how to use HubSpot effectively in their workflows. Below is a step-by-step guide to help you create comprehensive documentation tailored to agent users (e.g., customer support, sales, or service agents). This guide assumes you are documenting an existing setup in HubSpot, such as workflows, dashboards, tickets, or other tools agents use.
1. Define the Purpose and Audience
Before you start, clarify the purpose of the documentation and the target audience:
- Purpose: To guide agent users on how to navigate and use HubSpot tools, features, and workflows to perform their daily tasks efficiently.
- Audience: Agents (e.g., customer support reps, sales reps, or service team members) who use HubSpot as part of their job.
Include this information in the introduction of your documentation to set expectations.
2. Gather Information About the Existing Setup
To document the existing HubSpot setup, you need to collect details about the tools, workflows, and configurations agents use. Here’s how to gather this information:
- Interview Stakeholders: Speak with team leads, managers, or HubSpot administrators to understand the purpose of the current setup and the agent workflows.
- Review HubSpot Configuration:
- Check dashboards, reports, and widgets agents use.
- Review ticket pipelines, statuses, and properties.
- Examine workflows, automation, and triggers relevant to agents.
- Identify custom objects, forms, or integrations agents interact with.
- Note any email templates, snippets, or sequences agents use.
- Observe Agent Workflows: Shadow agents or review their typical tasks to understand how they use HubSpot in practice.
- Access Permissions: Document the permissions and access levels agents have (e.g., view-only, edit, or admin access to certain tools).
3. Structure Your Documentation
Organize the documentation in a logical, user-friendly format. Below is a suggested structure:
Title
- Example: "HubSpot Guide for Customer Support Agents"
Table of Contents
- Include clickable links to sections for easy navigation.
1. Introduction
- Purpose of the guide.
- Who should use this guide (e.g., customer support agents).
- How to use the guide (e.g., step-by-step instructions, troubleshooting tips).
2. Getting Started
- Accessing HubSpot:
- How to log in (e.g., URL, SSO instructions).
- Overview of the HubSpot interface (e.g., navigation bar, key sections like Tickets, Contacts, Reports).
- Agent Permissions:
- What agents can and cannot do in HubSpot based on their user role.
- Key Terminology:
- Define HubSpot-specific terms agents need to know (e.g., tickets, pipelines, workflows, properties).
3. Core Agent Workflows
Break down the key tasks agents perform in HubSpot. For each task, include:
- Task Name: A clear, descriptive title (e.g., "Creating a New Ticket").
- Purpose: Why agents perform this task.
- Step-by-Step Instructions: Detailed steps with screenshots or videos.
- Best Practices: Tips for efficiency or accuracy.
- Common Issues and Troubleshooting: How to handle errors or unexpected behavior.
Example tasks to document:
- Managing Tickets:
- How to create, update, and close tickets.
- How to assign tickets to team members.
- How to use ticket statuses and pipelines.
- Using Dashboards and Reports:
- How to access and interpret agent-specific dashboards.
- How to filter or customize reports.
- Communicating with Customers:
- How to send emails from HubSpot (using templates or snippets).
- How to log calls, notes, or meetings.
- How to use the chat or inbox feature (if applicable).
- Using Workflows:
- How to enroll contacts or tickets in workflows (if agents have access).
- How to check the status of automated actions.
- Searching and Managing Records:
- How to search for contacts, companies, or deals.
- How to update properties or merge duplicate records.
4. Tools and Features
Document specific HubSpot tools or features agents use, such as:
- Tickets: Overview of ticket properties, pipelines, and statuses.
- Dashboards: List of dashboards agents should use and what each widget shows.
- Email Templates and Snippets: How to access and use pre-built templates or snippets.
- Knowledge Base: How to search for and share knowledge base articles with customers.
- Integrations: How to use integrations (e.g., Slack, Zoom, or other tools) within HubSpot.
5. Best Practices and Tips
Provide guidance to help agents work more efficiently, such as:
- Keyboard shortcuts in HubSpot.
- How to prioritize tickets or tasks.
- How to use filters to manage workloads.
- Tips for maintaining data hygiene (e.g., avoiding duplicate records).
6. Troubleshooting and FAQs
Include a section to address common issues agents may encounter, such as:
- "I can’t find a ticket I created."
- "My dashboard isn’t showing the right data."
- "I don’t have permission to perform an action."
- "How do I reset my password?"
7. Resources and Support
- Links to HubSpot’s help center or knowledge base.
- Contact information for internal HubSpot administrators or IT support.
- Links to training videos or additional resources.
8. Appendix (Optional)
- Glossary of terms.
- List of custom properties or fields agents use.
- Screenshots or diagrams of workflows or pipelines.
4. Use Visuals and Examples
Make the documentation engaging and easy to follow by including:
- Screenshots: Highlight key areas of the HubSpot interface (e.g., buttons, menus, fields).
- Videos: Record short walkthroughs of complex tasks (e.g., creating a ticket or using a dashboard).
- Examples: Provide real-world examples of tickets, emails, or reports agents might encounter.
- Callouts: Use arrows, boxes, or text overlays in screenshots to draw attention to important areas.
5. Write in a User-Friendly Style
- Use Simple Language: Avoid jargon unless it’s HubSpot-specific and defined in the glossary.
- Be Concise: Use bullet points, numbered lists, and short paragraphs.
- Use Active Voice: Write instructions in an active, direct style (e.g., "Click the 'Create Ticket' button" instead of "The 'Create Ticket' button should be clicked").
- Be Consistent: Use consistent terminology and formatting throughout the document.
6. Choose a Documentation Format
Decide how to present and share the documentation. Options include:
- PDF: Good for static, printable guides.
- Google Docs or Word: Easy to edit and share.
- Confluence or Notion: Ideal for collaborative, searchable documentation.
- HubSpot Knowledge Base: If your company uses HubSpot’s knowledge base, you can create internal articles for agents.
- Video Tutorials: Use tools like Loom or Camtasia to create video guides.
7. Test and Validate the Documentation
Before finalizing, ensure the documentation is accurate and helpful:
- Test the Steps: Follow your own instructions to ensure they work as described.
- Get Feedback: Share the draft with a few agents and managers to gather feedback.
- Iterate: Update the documentation based on feedback and test again.
8. Maintain and Update the Documentation
HubSpot setups evolve over time, so plan to keep the documentation up to date:
- Assign Ownership: Designate someone (e.g., a HubSpot admin) to maintain the documentation.
- Track Changes: Use version control or a changelog to document updates.
- Schedule Reviews: Review the documentation periodically (e.g., quarterly) to ensure it reflects the current setup.
Example Documentation Snippet
Here’s an example of how a section might look:
3.1 Creating a New Ticket
Purpose: To log a customer issue or request in HubSpot for tracking and resolution.
Step-by-Step Instructions:
- Log in to HubSpot at yourcompany.hubspot.com.
- From the top navigation bar, click Service > Tickets.
- In the top-right corner, click the Create Ticket button.
- Fill in the required fields:
- Ticket Name: Enter a brief description of the issue (e.g., "Customer unable to log in").
- Pipeline: Select the appropriate pipeline (e.g., "Customer Support").
- Ticket Status: Set the status (e.g., "New").
- Contact: Search for and select the customer’s contact record.
- Priority: Choose a priority level (e.g., "High" for urgent issues).
- Add any additional details in the Description field.
- Click Save to create the ticket.
Best Practices:
- Always search for the customer’s contact record before creating a ticket to avoid duplicates.
- Use the Priority field to help the team prioritize urgent issues.
Common Issues:
- Issue: "I don’t see the 'Create Ticket' button."
- Solution: Ensure you have the correct permissions. Contact your HubSpot admin if you need help.
Screenshot: [Insert screenshot of the "Create Ticket" form with callouts for key fields.]
9. Additional Tips
- Customize for Your Team: Tailor the documentation to your team’s specific workflows, tools, and terminology.
- Include Real Data (Anonymized): Use anonymized examples of tickets, emails, or reports to make the documentation relatable.
- Make It Searchable: If using a digital platform, ensure the documentation is searchable by keywords agents might use (e.g., "ticket," "dashboard," "email").
By following these steps, you’ll create a comprehensive, user-friendly guide that empowers agent users to navigate and use HubSpot effectively. Let me know if you need help with specific sections or examples!
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.