Skip to content
EkLine Documentation

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”

  1. Go to Settings > Organization > Integrations in your EkLine dashboard.

  2. Find Slack in the integrations list.

  3. Click Connect.

  4. Allow EkLine to access your Slack workspace in the OAuth 2.0 popup.

  5. Complete the Slack authorization flow.

  6. 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”

  1. In any Slack channel or thread, type @EkLine followed by your request.

    @EkLine create a troubleshooting guide based on this discussion

  2. Follow the live progress message. A single message updates in place to show what Docs Agent is doing as it analyzes the conversation and drafts the documentation, which typically takes 10-30 seconds.

  3. On the first response in a thread, Docs Agent adds a View EkLine chat button. Click it to open the session in EkLine, where you can review and edit the draft.

  4. Read Docs Agent’s reply. When the agent finishes, the live progress message disappears and the agent posts its own reply directly in the thread, along with an expandable diff of the proposed changes.

  5. Docs Agent automatically creates a pull request with the drafted changes and includes the PR link in its reply.

Automatic pull requests

Section titled “Automatic pull requests”

When you @mention EkLine in Slack, Docs Agent automatically opens a pull request with the drafted changes. This behavior defaults to enabled for all organizations.

Docs Agent includes the PR link in its Slack reply 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:

  1. Go to Settings > Organization > Docs Agent in your EkLine dashboard.
  2. Under Slack triggers, turn off the Automatically raise PRs from Slack requests toggle.
  3. 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 typeWhat the bot captures
Thread messagesAll messages in the current thread
Channel messagesThe last 10 messages before your @mention
File attachmentsImages (JPEG, PNG, GIF, WebP), PDFs, and videos attached to the message
ReactionsEmoji 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”
IssueSolution
Bot does not respondVerify the workspace connection in Settings > Organization > Integrations. Check that the bot has access to the channel.
”Workspace not connected” errorAsk a workspace administrator to reconnect the integration in EkLine settings.
Draft does not match expectationsGive more specific instructions in your mention. Include the documentation type and key topics to cover.
Bot takes longer than expectedComplex requests may take longer. The bot notifies you if a request times out.
Bot responds but link is brokenRefresh the page and try the link again. If the issue persists, contact support@ekline.io.

Next steps

Section titled “Next steps”