-
Notifications
You must be signed in to change notification settings - Fork 4
content: The Feedback Loop Missing from Most Developer Relations Docs #794
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| title: 'The Feedback Loop Missing from Most Developer Relations Docs' | ||
| subtitle: Published July 2026 | ||
| description: >- | ||
| Most DevRel teams treat documentation as a publishing problem. The harder problem is what documentation reveals about where developers actually fail. | ||
| date: '2026-07-27T00:00:00.000Z' | ||
| author: Frances | ||
| tag: Technical | ||
| section: Use Cases | ||
| hidden: false | ||
| --- | ||
| import BlogNewsletterCTA from '@components/site/BlogNewsletterCTA.astro'; | ||
| import BlogRequestDemo from '@components/site/BlogRequestDemo.astro'; | ||
|
|
||
| A developer searches your docs for "rate limit exceeded." No results. They try "429 error." Nothing. They open your community Slack and ask. Someone answers six hours later. | ||
|
|
||
| Your documentation platform logged that search query. Your docs analytics show a high-exit page on the error reference. Your Slack has the thread now. None of it made it back into a documentation review queue. | ||
|
|
||
| That's the gap most developer relations docs have: not missing content, but missing feedback loops. | ||
|
|
||
| ## The conventional approach and its limit | ||
|
|
||
| Most DevRel teams treat documentation as a publishing problem. The questions are: what to write, how to structure it, where to host it, who should review before it ships. | ||
|
|
||
| These are real problems. But they're upstream of the harder one: what happens after documentation is published? | ||
|
|
||
| [Postman's 2024 State of the API report](https://www.postman.com/state-of-api/2024) found that 44% of developers still dig through source code to understand APIs because documentation is insufficient. That number doesn't mean documentation was never written. It means developers encountered it and it didn't answer their question. Another 39% cite inconsistent documentation as the single biggest barrier to API collaboration. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Blocking (small fix) — the 44% figure is real, but the draft adds a cause the report does not state, and the cited link doesn't contain either number. I pulled the actual 2024 State of the API PDF and checked both stats. Good news: your numbers are accurate, which is more than I can say for a lot of AI-drafted stats. Two problems with how they're presented. 1. The "because documentation is insufficient" clause is your inference, not Postman's finding. The report says, verbatim: "44% of developers dig through source code to understand APIs, but over half collaborate with product managers, QA, and designers who can't always interpret the code." Postman's framing is a collaboration problem — the code is unreadable to non-developer teammates. It attributes no cause for the 44%. As written, the draft reports a causal finding the source doesn't make, and then the next two sentences ("That number doesn't mean documentation was never written. It means developers encountered it and it didn't answer their question.") build further on that unsupported reading. Attribute the interpretation to yourself rather than to Postman. 2. The 39% is real but slightly mis-scoped. Verbatim: "58% of developers rely on internal documentation, but 39% say inconsistent docs are the biggest roadblock." That is the biggest roadblock to learning and using internal APIs, and the 39% is a share of the developers relying on internal docs. "The single biggest barrier to API collaboration" overstates the scope, and "single" is doing work the source doesn't support. Dropping "single" and saying "internal API documentation" fixes it. 3. The link goes to an archive index that contains neither statistic. Suggested rewrite:
One consistency note for later, not a change request here: |
||
|
|
||
| The developers who search your docs and find nothing are sending you a product signal. Most DevRel teams aren't receiving it. | ||
|
|
||
| ## What documentation reveals | ||
|
|
||
| Every documentation surface generates signals. Most teams aren't reading them systematically. | ||
|
|
||
| **Search queries with no results** show where developers expected to find something and couldn't. A query for "rate limit exceeded" with no results means a developer hit an error your docs don't address. The query is a content brief. Teams that review these regularly find they surface a predictable category of missing content: error handling and edge cases. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-blocking — unsourced empirical claim, and it overlaps an existing article that has actual numbers. "Teams that review these regularly find they surface a predictable category of missing content: error handling and edge cases." This is stated as an observed finding about what teams discover, with no source. It's plausible and it's the kind of sentence a reader will believe, which is why it should either get a citation or get softened to a claim you're making rather than a finding you're reporting. Cheapest fix: "In my experience these cluster in one place: error handling and edge cases" — or drop the empirical framing and keep it as an assertion. Related, and worth a look before publishing: That article is |
||
|
|
||
| **High-exit pages** show where developers gave up. A developer who bounces from step two of your quickstart after 45 seconds did not successfully onboard. A page with a high exit rate and short dwell time means the content didn't resolve the problem it was supposed to resolve. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-blocking — invented specifics presented as if they mean something. "A developer who bounces from step two of your quickstart after 45 seconds did not successfully onboard." The 45 seconds is a made-up number doing rhetorical work — it reads as if it's a threshold from somewhere. Nothing turns on it, and dropping it costs the sentence nothing: "A developer who bounces from step two of your quickstart did not successfully onboard." Same paragraph: "means the content didn't resolve the problem it was supposed to resolve" repeats "resolve" and restates the preceding sentence. "means the content didn't answer the question that brought them there" is tighter. Flagging this one specifically because plausible-looking invented specifics are a characteristic AI-draft failure, and it's the only clear instance I found in the piece — worth a scan for others when you do your own pass. |
||
|
|
||
| **Community questions** are the most explicit signal. When developers ask the same question in your forum, Discord, or GitHub Issues, they're telling you in their own words what your documentation failed to explain. Twilio's DevRel team has credited this approach publicly: community feedback drove documentation improvements that led to new API creation, because recurring questions revealed a use case the product hadn't yet addressed. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Blocking — the Twilio claim does not survive checking, and the "new API creation" half looks like it came from an uncited source. This is the highest-risk sentence in the draft: a specific factual assertion about a named third-party company's internal practice, published without a citation. I tried hard to substantiate it and split it into two halves. "Twilio's DevRel team has credited this approach publicly" — supportable, but not for the mechanism you describe. Twilio's Dev Ed leadership has publicly described docs feedback loops, so the general idea is real. But the signals they actually describe are on-page star ratings, moderated user testing, card-sorting, and one-to-one developer conversations — not "your forum, Discord, or GitHub Issues." Andrew Baker (Director of Developer Education at Twilio) in this Decibel interview: a widget "gives developers the ability to rate a piece of content," and "their star rating and comments are automatically sent to a Slack channel that the Dev Ed team monitors." That Slack channel is internal, not a community channel. Neither that source nor Baker's devrel.ai interview mentions forums, Discord, or GitHub Issues at all. So Twilio is currently attached to the wrong sub-claim in this paragraph. "led to new API creation" — I could not substantiate this at all. The only source on the open web asserting it is a self-published GitHub whitepaper ( There is a real, citable Twilio example that is very close to what you want — it was the CLI, not an API. Same Decibel interview: the Dev Ed team "piloted Twilio's Command Line Interface after seeing through docs feedback" that developers welcomed it, and "A month after prototyping the CLI, it went into R&D, and is now in Twilio's Developer Toolchain." That is genuinely docs-feedback-drove-a-new-product, which makes your point without overreaching. Suggested rewrite that keeps the paragraph's argument and cites what the record supports:
If you have a source for the original new-API version, I'd rather use it than the CLI — please point me at it and I'll re-check. Otherwise this needs a citation or needs to go. |
||
|
|
||
| **Support tickets** carry similar signal. When a ticket is about something your documentation should cover, it is documentation debt with a human cost on both sides. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-blocking — this bullet is thin next to the other three. The other three signals each get a mechanism and a concrete instance. Support tickets get two sentences, one of which ("carry similar signal") mostly points at the previous bullet, and the payoff ("documentation debt with a human cost on both sides") is a phrase rather than an observation. This is the one place in the article where I'd call the prose padding. Support tickets also have the strongest claim of the four to being measurable — ticket deflection is the metric DevRel teams actually report upward, and you invoke exactly that at line 53. Worth two more sentences on what distinguishes a ticket signal from a community-question signal: a ticket has an owner, a timestamp, and a resolution, so it's the one signal you can price. That would also set up the outcome-measurement argument that follows. You have room — 854 words against a 1400 ceiling. |
||
|
|
||
| None of this is new information. What's missing is the operational loop that routes these signals to the people who can act on them. | ||
|
|
||
| <BlogNewsletterCTA /> | ||
|
|
||
| ## Why the loop stays open | ||
|
|
||
| The signal data exists. DevRel teams have access to search logs, docs analytics, and community channels. The reason it doesn't close is that no one owns the connection between those channels and the documentation queue. | ||
|
|
||
| Documentation decisions and community observation usually sit with different people. A developer advocate who hears a recurring question in Discord is not always the person who can update the docs. A technical writer who owns the documentation platform is not always watching community channels. Without a defined handoff, the information stays siloed and documentation strategy stays driven by internal assumptions about what developers need. | ||
|
|
||
| This shows up in how DevRel teams measure their work. [Proving documentation ROI](https://promptless.ai/blog/technical/developer-documentation-roi) is one of the harder DevRel problems, and part of the reason is that most teams measure documentation output (pages published, tutorials created) rather than documentation outcomes (search success rate, support ticket deflection). The feedback loop is what makes outcome measurement possible, because you can only track whether documentation worked if you're watching for cases where it didn't. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-blocking — longest sentence in the piece, at 36 words. "[Proving documentation ROI] is one of the harder DevRel problems, and part of the reason is that most teams measure documentation output (pages published, tutorials created) rather than documentation outcomes (search success rate, support ticket deflection)." The style guide targets a 10th-grade reading level with short sentences, and this one carries three ideas plus two parenthetical lists. It's the only sentence in the article I had to re-read. Split at the pivot:
Both internal links in the article resolve correctly, including this one — I checked each in its exact authored form. |
||
|
|
||
| ## Building the loop operationally | ||
|
|
||
| A working documentation feedback loop needs three components. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Non-blocking — the article's most useful section is its least specific. "A working documentation feedback loop needs three components" is the operational payoff, and it's where a developer advocate decides whether to act. Right now two of the three components are close to generic advice: "Designate someone to review documentation search logs weekly" and "Create a lightweight process" could appear in an article about any signal-routing problem. The routing bullet is the exception and it's the best writing in the section, because the GitHub-issue-labeled- The thesis is sound and the article earns this section. It just stops one level short of usable. Concretely, the things a reader can't get from the draft as written:
This is a request to sharpen, not a correctness problem — hence non-blocking. |
||
|
|
||
| **Signal collection.** Designate someone to review documentation search logs weekly, flag pages with high exit rates from your analytics, and compile community questions by category. Most DevRel teams already have access to this data. The gap is formalizing the review. | ||
|
|
||
| **Routing.** Create a lightweight process for moving signals into a documentation queue. A GitHub issue labeled "docs-gap" with the search query that surfaced it is enough. The goal is getting information out of community channels and into a system where it can be prioritized and assigned. | ||
|
|
||
| **Prioritization by traffic impact.** When gaps are identified, prioritize based on the number of developers affected. A missing error code explanation searched 200 times a week ranks above a detailed architecture explainer with 30 monthly views. Documentation debt that affects the [highest-traffic paths](https://promptless.ai/blog/technical/documentation-debt-accrues-where-your-team-cant-see-it) compounds fastest. | ||
|
|
||
| The teams that do this well find the loop running in both directions. Signals about documentation gaps feed the writing queue. Recurring questions about undocumented behavior feed the product roadmap. Documentation becomes a listening instrument alongside its function as a publishing channel. | ||
|
|
||
| Getting signal collection right is the hard part. The sources exist: search logs, analytics, community channels, support queues. The operational work is connecting them into a system that routes signals to the right people before developers have already moved on. | ||
|
|
||
| <BlogRequestDemo /> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Blocking (style rule) — this is the "X is not Y, but Z" construction the repo style guide explicitly bans.
.claude/skills/generate-article/references/style-guide.mdlists this pattern under Banned patterns with near-identical examples ("This isn't a tooling problem, it's a process problem"), and instructs rewriting as a direct statement of what the thing is, without the negation setup. "not missing content, but missing feedback loops" is exactly the shape.It's also the article's thesis sentence, so it's the one place worth getting into positive form.
Two more instances of the same pattern to clean up while you're in here, both non-blocking on their own:
Good news on the rest of the style pass: zero em dashes in the file, no tricolons I could find, word count 854 (inside the 800–1400 band),
<BlogNewsletterCTA />lands at 53% (spec says roughly 40–50% — close enough that I'm not flagging it), no generic restating conclusion, and the description is 149 characters, inside the 120–160 target. That's a cleaner style baseline than the last article I reviewed.