Skip to content

Benefit-first communication pass across README, docs, and descriptions - #31

Merged
Byggarepop merged 1 commit into
mainfrom
docs/benefit-first-communication
Jul 29, 2026
Merged

Benefit-first communication pass across README, docs, and descriptions#31
Byggarepop merged 1 commit into
mainfrom
docs/benefit-first-communication

Conversation

@Byggarepop

Copy link
Copy Markdown
Owner

What

Reframes all user-facing text to lead with the problem the tool solves (forgotten companion changes) instead of the mechanism (change coupling, repository mining). No behavior changes.

  • README: new opening — "Catch the files you — or your AI agent — forgot to change." Defines hole on first use, adds a plain-text sample of check output, and rewrites the demo captions to describe what each screenshot shows.
  • docs/README: same caption rewrite, plus a two-line hole definition under the title (docs get deep-linked directly). Research, prior-art, and threshold sections untouched.
  • NuGet <Description>, CLI --help header, and MCP registry description (.mcp/server.json): rewritten benefit-first; tags unchanged.

Why

First-time visitors were greeted with field jargon ("the free, agent-native slice of change coupling") before learning what the tool does for them. The change-coupling framing stays in docs where it earns its keep with tech leads; the front page now sells the outcome.

The mcp-name registry marker in README is untouched.

🤖 Generated with Claude Code

Reframe user-facing text to lead with the problem solved (forgotten
companion changes) instead of the mechanism (change coupling, mining):

- README: new benefit-first opening, define "hole" on first use, add a
  plain-text sample of check output, rewrite demo captions
- docs: same captions, one-line hole definition under the title;
  research/threshold sections unchanged
- NuGet Description, CLI --help header, and MCP registry description
  rewritten benefit-first

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Byggarepop
Byggarepop merged commit 00d1d3e into main Jul 29, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant