Skip to content

Commit 780aab7

Browse files
authored
(ask fern) Add indexing example to slack instructions; small formatting updates (#1085)
1 parent 45d7cd8 commit 780aab7

File tree

1 file changed

+45
-14
lines changed

1 file changed

+45
-14
lines changed

fern/products/ask-fern/pages/features/slack-app.mdx

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@ Fern stores all questions and answers from Slack interactions for [analytics pur
1111

1212
Install the Ask Fern app and add the bot to customer channels.
1313

14-
<AccordionGroup>
15-
<Accordion title="Install for your organization">
14+
### Install for your organization
1615

1716
To install Ask Fern in your organization's Slack workspace, you must be a Slack admin. Follow these steps:
1817

@@ -23,8 +22,7 @@ To install Ask Fern in your organization's Slack workspace, you must be a Slack
2322
<img src="/products/ask-fern/pages/assets/allow-slack.png" alt="Allow Ask Fern for Slack workspace" />
2423
</Frame>
2524

26-
</Accordion>
27-
<Accordion title="Enable for customer workspaces">
25+
### Enable for customer workspaces
2826

2927
To give customers access to the Ask Fern bot in their own Slack workspaces:
3028

@@ -41,15 +39,12 @@ To give customers access to the Ask Fern bot in their own Slack workspaces:
4139
1. Once the customer has installed the Ask Fern app, you must add the bot to your customer Slack channel to give it access.
4240

4341
Once added, customers will see that `@Ask Fern was added to the channel`. They can start asking questions immediately.
44-
</Accordion>
45-
</AccordionGroup>
4642

4743
## Configuration
4844

4945
Customize the bot's behavior to match your workflow needs.
5046

51-
<AccordionGroup>
52-
<Accordion title="Bot settings per channel">
47+
### Bot settings per channel
5348

5449
Use the `/configure` slash command in any channel to adjust the settings:
5550

@@ -64,8 +59,7 @@ Use the `/configure` slash command in any channel to adjust the settings:
6459
<img src="/products//ask-fern/pages/assets/respond-all-slack.png" alt="Respond all setting in Slack" />
6560
</Frame>
6661

67-
</Accordion>
68-
<Accordion title="Customize the bot name">
62+
### Customize the bot name
6963

7064
You can rename the bot to match your brand (example: "YourCompanyName Support"):
7165

@@ -80,8 +74,8 @@ You can rename the bot to match your brand (example: "YourCompanyName Support"):
8074
</Frame>
8175

8276
Now customers will see `@YourCompanyName Support was added to the channel` instead of the default `@Ask Fern` name.
83-
</Accordion>
84-
<Accordion title="Improve responses with indexing">
77+
78+
### Collaborative FAQ generation
8579

8680
You can improve the Slack bot's knowledge base by teaching it from real customer interactions. When the bot provides answers in Slack, you can refine those responses and save them for future reference.
8781

@@ -96,15 +90,52 @@ How it works:
9690

9791
Once indexed, Ask Fern will use this curated question-answer pair to inform future responses to similar questions, giving more accurate answers over time.
9892

93+
94+
<Accordion title="Indexing conversation example">
95+
96+
**User –** *@PlantSupport* what's the best way to care for succulents
97+
indoors?
98+
99+
**Plant Support bot –** Succulents need bright, indirect light and should be watered every 2-3 weeks. Make sure the soil dries out completely between waterings.
100+
101+
**Support Lead –** *@PlantSupport* This is good but you should mention drainage holes and the
102+
risk of root rot. Also, watering frequency depends on the season - less in
103+
winter. Let's index this thread.
104+
105+
**Plant Support bot:** I'd be happy to help you index this thread! Let me work
106+
with you to create a clear Q&A pair for your knowledge base. Based on the
107+
conversation, the main question is about caring for indoor succulents. Let me
108+
draft an improved Q&A pair:
109+
110+
Question: "What's the best way to care for succulents indoors?"
111+
112+
Ideal Response:
113+
114+
Succulents thrive indoors with the following care:*
115+
116+
- Light: Provide bright, indirect sunlight (6+ hours daily near a south or east-facing window)
117+
- Watering: Water thoroughly every 2-3 weeks during spring and summer,
118+
reducing to once a month in winter. Always wait until the soil is
119+
completely dry between waterings
120+
- Drainage: Use pots with drainage holes and well-draining soil
121+
(cactus/succulent mix) to prevent root rot
122+
- Warning: Overwatering is the most common cause of succulent death. Root rot
123+
develops quickly in waterlogged soil
124+
125+
Does this capture the question and response accurately? Would you like me to adjust anything before saving it to your knowledge base?
126+
127+
**Support Lead:** *@PlantSupport* Perfect! Please save this.
128+
129+
**Plant Support bot –** Successfully indexed! This Q&A pair has been added to your knowledge base and will be used to inform future responses about indoor succulent care.
130+
99131
</Accordion>
100-
</AccordionGroup>
132+
101133

102134
## Architecture
103135

104136
When a user asks Ask Fern a question in Slack, a webhook triggers Fern's servers to search your documentation database and retrieve relevant context. Using that context, Ask Fern generates a response.
105137

106138
<Accordion title="Diagram">
107-
108139
```mermaid
109140
sequenceDiagram
110141
autonumber

0 commit comments

Comments
 (0)