Docs Agent Slack bot
Create documentation drafts directly from Slack by @mentioning EkLine in any channel or thread.
Create documentation without leaving Slack. @mention EkLine in any channel or thread, and the bot generates a draft you can review and edit in EkLine.
Prerequisites
Section titled “Prerequisites”Before you begin, you need:
- An EkLine organization account.
- Slack workspace administrator access to install the app.
- Docs Agent access enabled for your organization.
Connect your Slack workspace
Section titled “Connect your Slack workspace”-
Go to Settings > Organization > Integrations in your EkLine dashboard.
-
Find Slack in the integrations list.
-
Click Connect.
-
Allow EkLine to access your Slack workspace in the OAuth 2.0 popup.
-
Complete the Slack authorization flow.
-
Verify the integration shows as Connected.
Once connected, anyone in the Slack workspace can mention @EkLine to create documentation drafts.
Create documentation from Slack
Section titled “Create documentation from Slack”-
In any Slack channel or thread, type
@EkLinefollowed by your request.@EkLine create a troubleshooting guide based on this discussion -
Wait for the bot to acknowledge with an eyes emoji and a message: “Got it! I’m looking into this now.”
-
The bot analyzes the conversation and generates a draft, which typically takes 10-30 seconds.
-
Click the link in the bot’s response to review and edit the draft in EkLine.
-
The Docs Agent automatically creates a pull request with the drafted changes. The PR link appears in the editor session.
Automatic pull requests
Section titled “Automatic pull requests”When you @mention EkLine in Slack, the Docs Agent automatically opens a pull request with the drafted changes. This behavior defaults to enabled for all organizations.
The PR link appears in the editor session so you can review and merge the changes directly from GitHub.
Disable automatic PRs
Section titled “Disable automatic PRs”If you prefer to review drafts in the editor before creating a PR manually:
- Go to Settings > Organization > Docs Agent in your EkLine dashboard.
- Under Slack triggers, turn off the Automatically raise PRs from Slack requests toggle.
- The setting takes effect on the next Slack request. Existing sessions are unaffected.
Context the bot captures
Section titled “Context the bot captures”The bot gathers context from the conversation to produce accurate documentation:
| Context type | What the bot captures |
|---|---|
| Thread messages | All messages in the current thread |
| Channel messages | The last 10 messages before your @mention |
| File attachments | Images (JPEG, PNG, GIF, WebP), PDFs, and videos attached to the message |
| Reactions | Emoji reactions on messages |
Write effective prompts
Section titled “Write effective prompts”The quality of your prompt determines the quality of the output.
| Instead of… | Try… |
|---|---|
| “help with docs" | "Create a troubleshooting guide for the API timeout issue discussed here" |
| "document this" | "Write a how-to guide for the workaround Sarah described" |
| "make docs" | "Update the authentication docs based on the new flow we agreed on” |
Include specific details:
- Reference the type of documentation you need: tutorial, how-to guide, reference, troubleshooting.
- Name specific topics or features from the conversation.
- Mention existing documentation to update if applicable.
- Point to URLs or ticket IDs for more context.
Troubleshooting
Section titled “Troubleshooting”| Issue | Solution |
|---|---|
| Bot does not respond | Verify the workspace connection in Settings > Organization > Integrations. Check that the bot has access to the channel. |
| ”Workspace not connected” error | Ask a workspace administrator to reconnect the integration in EkLine settings. |
| Draft does not match expectations | Give more specific instructions in your mention. Include the documentation type and key topics to cover. |
| Bot takes longer than expected | Complex requests may take longer. The bot notifies you if a request times out. |
| Bot responds but link is broken | Refresh the page and try the link again. If the issue persists, contact support@ekline.io. |
Next steps
Section titled “Next steps”- GitHub PR bot — Trigger Docs Agent from pull request comments and code reviews.
- Create documentation — Generate READMEs, API references, and guides from your codebase.
- Update and review — Keep documentation in sync with code changes.
- Integrations — Connect Notion, Linear, Jira, and other tools.