Turn a release into docs, release notes and a launch post
The Docs Agent updates the docs the release affects and writes the release notes in one pull request. The Marketing Agent then drafts the launch post from the same changes. Your team reviews both before anything goes out.
The example follows Acme, which sells a payments API and has shipped split payouts in its 2.4 release.
What you need
Section titled “What you need”- The Docs Agent and the Marketing Agent.
- The repository that holds your docs, and the repositories where product changes land, connected through GitHub or GitLab.
- Jira or Linear connected, so the agents can read the shipped tickets. See Integrations.
- Tone and Voice filled in on your Company Profile, so the post sounds like you. See Company Profile and Domains.
1. Decide what shipped
Section titled “1. Decide what shipped”Decide how to name the release, because both agents start from it:
- for the Docs Agent: a Jira
fixVersion, a Linear project or milestone, or a range of tickets such asENG-100throughENG-110 - for the Marketing Agent: a time window such as “releases since September 1”, or the pull request numbers, release tag or changelog file
Acme uses the Jira version 2.4 for the docs and the release tag v2.4.0 for the post.
2. Update the docs and write the release notes
Section titled “2. Update the docs and write the release notes”In a Docs Agent session, ask the agent to update the docs the release affects, add release notes, and check for pages the release left out of date. It drafts everything in one session, and you ship it as one pull request.
- Follow Tutorial: document a release end to end for the whole session.
- See Generate release notes for how to group and word the notes.
Release notes and changelog pages are Docs Agent work. The Marketing Agent does not write them.
3. Merge and publish the docs
Section titled “3. Merge and publish the docs”Your team reviews the docs pull request and merges it, then publishes the docs as usual. See How EkLine opens pull requests.
Do this before you draft the post. The Marketing Agent opens the post’s call-to-action link to check that it works, and marks the link as missing when it does not.
4. Draft the launch post
Section titled “4. Draft the launch post”Start a Marketing Agent session, select Blog post, and name the release from stage 1. Under Sources and files, paste the links to the docs pages from stage 2, or the docs pull request, so the post rests on the updated docs. To get a LinkedIn post or a newsletter section from the same changes, select LinkedIn post or Newsletter section under Also make, from the same brief.
The agent recommends how big the announcement should be, from a single changelog line to a company launch. It leaves out changes that were reverted, security fixes, work still behind a flag, and internal or docs-only changes. A launch post says who can use the feature today. Nothing starts this session on its own when you merge or release: you start it.
See Turn shipped changes into launch content for the steps and the full list of what is left out.
5. Review and publish the post
Section titled “5. Review and publish the post”Read the Marketing Agent’s summary in the chat: what it read, with sources, and what it assumed. Edit the draft in the editor, then click Copy or Download and publish the post on your blog yourself.
6. Optional: repeat every week
Section titled “6. Optional: repeat every week”Two Automations in the Releases and reports category cover the weekly part of this job. Both run as Docs Agent sessions, weekly on Monday by default:
| Automation | What it does |
|---|---|
| Release Notes Generator | Generates structured release notes from tickets and GitHub activity since the last release-notes update. |
| Release Marketing Brief | Drafts a Slack-ready brief of significant customer-facing features that shipped in the last 7 days, as raw material for marketing and customer success teams. |
The brief is a starting point for a person, not a Marketing Agent draft: no automation starts a Marketing Agent session. See Keep your team informed.
Check the result
Section titled “Check the result”- The docs pull request is merged and the docs are published, with the updated pages and the release notes.
- The launch post is published, and its chat summary lists the pull requests, tickets or changelog entries it rests on.
- The post includes a line that says who can use the feature today.
Built on Potluck Docs, our open source template.