content: The Feedback Loop Missing from Most Developer Relations Docs - #794
content: The Feedback Loop Missing from Most Developer Relations Docs#794frances720 wants to merge 1 commit into
Conversation
…loper Relations Docs Keyword: developer relations docs Generated by edu campaign skill
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Documentation review: request changes (on details, not on the argument)
The thesis holds up. "Documentation generates more value as a signal-capture system than as a content delivery system, and most teams have no loop to read those signals" is a real, non-obvious claim, and the article actually argues it rather than asserting it in the intro and drifting. The four-signal taxonomy (zero-result searches, high-exit pages, community questions, support tickets) is the right decomposition, the diagnosis at "Why the loop stays open" — that no one owns the connection between community channels and the docs queue — is the genuinely useful insight, and the piece reads as substantive rather than filler. The opening scenario is concrete and the closing doesn't restate. I'd publish this after the fixes below; the changes I'm asking for are localized, not structural.
Since this was flagged as an AI-generated draft, I checked explicitly for the failure modes that kind of draft has: unsourced confident claims, invented statistics, case studies that don't survive checking, padding, an unargued thesis, and generic advice. Two of those landed (an unverifiable case study, one invented specific), one partially (a thin section, and the operational section is more generic than the rest). The thesis is argued and the real statistics are accurate.
Blocking
- The Twilio claim (line 39). The "led to new API creation" half is unsubstantiated. I traced the assertion to a self-published, uncited GitHub whitepaper and found no primary source; Twilio's own public record describes docs feedback producing the CLI, not an API. Separately, Twilio's documented feedback signals are on-page star ratings and user testing, not the forum/Discord/GitHub Issues mechanism the paragraph attaches them to. I am not saying the claim is false — I found nothing contradicting it — but we shouldn't publish an unsourced claim about another company's product decisions. There's a citable Twilio example that makes your point almost as well; suggested rewrite is inline. If you have a source for the original version, send it and I'll re-check rather than make you rewrite.
- The Postman stats (line 27). Both percentages are accurate — I pulled the actual PDF and verified 44% and 39% verbatim. But the draft attributes a cause ("because documentation is insufficient") that Postman doesn't state, overstates the 39%'s scope, and links to an archive index page that contains neither number. Fixes are inline.
- Banned style construction (line 19). "not missing content, but missing feedback loops" is the "X is not Y, but Z" pattern the repo style guide bans by name. It happens to be the thesis sentence.
Non-blocking
Line 35 (unsourced empirical claim + overlap with the existing metrics article), line 37 (invented "45 seconds"), line 41 (support-tickets bullet is thin), line 53 (36-word sentence), line 57 (the operational section stops one level short of actionable). Details inline. None of these need to block a merge if you disagree with them.
What I verified
- External claims. Postman 2024 State of the API: 44% dig through source code and 39% inconsistent-docs figures both confirmed verbatim against the report PDF, with the caveats above. Twilio: partially substantiated for docs feedback loops, not substantiated for new API creation or for community-channel signals (details inline, with the sources I checked).
- Links. All three resolve in their exact authored form: the Postman URL (308 to trailing-slash, harmless), and both internal blog links, whose target files exist on
main. The absolutehttps://promptless.ai/blog/...form matches house convention for blog cross-links. No trailing-slash-vs-redirect-source mismatch here. - Frontmatter. Schema-valid against
src/content.config.ts;title,description,subtitle,date,author,tag: Technical,section: Use Cases,hidden: falseall set correctly and consistent with sibling articles. Description is 149 characters (target 120–160) and, unlike the last PR I reviewed, it accurately describes the body. Blog pages route fromentry.id, so there is noslugorsidebar.*field to set here — those are Starlight docs-page concerns and correctly absent. - Style and structure. Zero em dashes, no tricolons, 854 words (band is 800–1400), CTA at 53%,
<BlogRequestDemo />closes the file, no generic conclusion, no "will"-for-product-behavior. I also ran the repo's owngenerate-article-workspace/grade.py: 8 of 9 assertions pass. The one failure ishidden_is_true, which is a stale eval assertion contradicting the skill's own instruction to "Always sethidden: false" — your value is correct, the check is wrong. Not your problem, but someone should fix that assertion. - Readability. Ran a plain-language pass. One sentence over the threshold (line 53); the rest sits comfortably at the target level.
Deliberately not blocking on
- The
documentation-metrics-and-analytics-a-complete-guide-for-dev.mdxoverlap on zero-result search. That article ishidden: trueand not live, so there's no SEO conflict today. Noted at line 35 in case it ever publishes. - The pre-existing 68%-outdated-docs stat in
technical-writing-with-ai.mdx:47, cited to this same Postman report. That figure does not appear in the 2024 PDF at all. Separate issue onmain, not this PR's job — flagged for whoever owns it. - CTA at 53% against a "roughly 40–50%" spec. Within tolerance.
Nice work on the style discipline in this one — the mechanical rules the last review flagged are all clean here. The remaining work is sourcing.
|
|
||
| **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. | ||
|
|
||
| **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. |
There was a problem hiding this comment.
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 (rohitg00/devrel-whitepaper), whose Section 4 reads "Twilio's DevRel team regularly collects feedback from their developer community, which has led to the creation of new APIs." That document has no named author, no Twilio affiliation, and carries no inline citation for the claim. Exact-phrase searches for the assertion return nothing else. I want to be precise: I did not find a source contradicting it, so I am not calling it false — it is unsupported, which for a claim about another company's product decisions is enough to block on.
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:
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 built this loop deliberately: every docs page carried a five-star rating widget whose scores and comments routed straight to a Slack channel the Dev Ed team monitored. That feedback did more than fix pages. The team piloted the Twilio CLI after docs feedback showed developers wanted one, and it shipped into Twilio's developer toolchain.
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.
|
|
||
| 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. |
There was a problem hiding this comment.
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. https://www.postman.com/state-of-api/2024 is the report archive page — I fetched it, and it has no percentages on it at all, only respondent counts. Both of your stats live in the PDF (https://voyager.postman.com/doc/postman-state-of-the-api-report-2024.pdf), on the "Key trends" and "API collaboration" pages. A reader who clicks to check you will not find the numbers. Note also that the bare URL 308-redirects to the trailing-slash form; harmless, but adding the slash avoids the hop.
Suggested rewrite:
Postman's 2024 State of the API report found that 44% of developers dig through source code to understand APIs. Reading that as a documentation signal: those developers had docs available and went to the source anyway. Another 39% say inconsistent documentation is the biggest roadblock to using internal APIs.
One consistency note for later, not a change request here: technical-writing-with-ai.mdx:47 cites the same report for "68% of developers cite outdated documentation as their top frustration." That figure does not appear in the 2024 PDF — 68% appears nowhere in it. Separate pre-existing issue, not yours to fix in this PR, but worth someone chasing.
|
|
||
| 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. |
There was a problem hiding this comment.
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.md lists 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.
That's the gap most developer relations docs have: the signals arrive, and nothing routes them back into the writing queue.
Two more instances of the same pattern to clean up while you're in here, both non-blocking on their own:
- Line 25: "But they're upstream of the harder one" is fine; the negation-shaped setup is mild. Leave it if you like it.
- Line 65: "Documentation becomes a listening instrument alongside its function as a publishing channel." This one reads as a workaround for the banned pattern and comes out stiff. "Documentation starts working as a listening instrument, not just a publishing channel" would be the natural phrasing but reintroduces the banned shape. Suggest: "The loop turns documentation into a listening instrument as well as a publishing channel."
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.
|
|
||
| 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. |
There was a problem hiding this comment.
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: documentation-metrics-and-analytics-a-complete-guide-for-dev.mdx already covers zero-result search rate in depth, including a sourced case (23% of queries returning zero results dropping to 6% over two quarters) and a very similar prioritization example ("A query returning no results 200 times monthly deserves immediate attention"). Your line 63 uses "searched 200 times a week," which is close enough to read as a duplicate.
That article is hidden: true, so it isn't live and there's no cannibalization risk today — but if it ever publishes, these two overlap substantially. Since it has the sourced numbers, consider borrowing one here and linking to it, which strengthens this section and internally links to a fourth post.
|
|
||
| **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. | ||
|
|
||
| **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. |
There was a problem hiding this comment.
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. | ||
|
|
||
| **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. |
There was a problem hiding this comment.
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.
|
|
||
| ## Building the loop operationally | ||
|
|
||
| A working documentation feedback loop needs three components. |
There was a problem hiding this comment.
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-docs-gap detail is concrete enough to copy.
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:
- Where the search-log data actually is. You name no platform. The metrics article names Algolia Analytics, GitBook, Fern, Document360 — naming two here would make the "most teams already have access" claim checkable rather than assumed.
- Who owns the review. "Designate someone" is the exact handoff failure the previous section diagnoses. Say which role: the person who owns the docs platform, or the advocate closest to the community channel.
- What cadence and what volume. "Weekly" is stated for search logs but not for community questions, and the section never says what a realistic queue looks like (five items a week? fifty?).
This is a request to sharpen, not a correctness problem — hence non-blocking.
|
|
||
| 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. |
There was a problem hiding this comment.
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:
Proving documentation ROI is one of the harder DevRel problems. Part of the reason is what teams measure: documentation output (pages published, tutorials created) rather than documentation outcomes (search success rate, support ticket deflection).
Both internal links in the article resolve correctly, including this one — I checked each in its exact authored form.
Keyword:
developer relations docsArticle plan
Thesis: DevRel documentation generates more value as a signal-capture system than as a content delivery system, but most teams have no loop to read those signals.
Key ideas:
Target reader: Developer advocates and DevRel managers who maintain documentation but haven't formalized a feedback loop.
File
src/content/blog/technical/developer-relations-docs-feedback-loop.mdxThis is an AI-generated draft and needs human review before publishing.
Generated by Claude Code