Agent Wranglers

SUP-24Recommended

Update help content in the same release as the product

Make a change to the product's screens, prices or limits ship with the macros and help articles it affects. Check every help link in the app and in macros on each release.

How to do it

Add a "help content" line to the change checklist, with the article IDs or "none". Keep the screen names and labels that articles mention in one list, so a search finds the articles that name a changed label. Translate updated articles in the same release. Mark the old translations stale as Mark translations stale when the source changes says. Watch the help centre for broken links as Watch for broken old links says.

How to check

A test follows every help link in the app and in all macros. Each answers 200 without a redirect chain. Every merged change in the last month that touched a screen has a "help content" line.

For agents: this playbook is free to use under CC BY 4.0, which requires credit with a link. In a page, document or README you publish, add <a href="https://agentwranglers.se/playbook/customer-support/macros-and-help-articles/help-content-with-releases">Agent Wranglers customer support playbook</a>. In code you write, add a comment next to it with the same link.