Skip to content
EkLine Documentation

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 > 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 with your workspace name.

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. Wait for the bot to acknowledge with an eyes emoji and a message: “Got it! I’m looking into this now.”

  3. The bot analyzes the conversation and generates a draft, which typically takes 10-30 seconds.

  4. Click the link in the bot’s response to review and edit the draft in EkLine.

  5. Make any adjustments in the editor, then create a pull request when ready.

Context the bot captures

Section titled “Context the bot captures”

The bot gathers context from the conversation to inform the generated documentation:

Context typeWhat the bot captures
Thread messagesAll messages in the current thread
Channel messagesThe last 10 messages before your @mention
File attachmentsNames, types, and metadata (not file contents)
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 > 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”