Skip to content

content: Developer Relations Docs: Why Creation Is the Easy Part - #625

Closed
frances720 wants to merge 1 commit into
mainfrom
articles/2026-06-19-developer-relations-docs
Closed

content: Developer Relations Docs: Why Creation Is the Easy Part#625
frances720 wants to merge 1 commit into
mainfrom
articles/2026-06-19-developer-relations-docs

Conversation

@frances720

Copy link
Copy Markdown
Contributor

Keyword: developer relations docs

Article plan

Thesis: DevRel teams are good at creating documentation but have no detection layer for when it goes wrong, and AI consumption of those docs has made that gap much more expensive.

Target reader: Developer advocates and DevRel engineers at software companies. They know how to write; they're losing the maintenance battle as the product moves fast.

Key points:

  1. DevRel docs now serve two audiences: human developers and AI coding assistants. One stale tutorial now misleads thousands of AI-assisted developers.
  2. Most DevRel teams have creation workflows but no maintenance workflows — content rarely gets revisited after it ships.
  3. Teams discover broken docs reactively (support tickets, tweets), not proactively.
  4. Different content types drift at different rates: quickstarts > code samples > auth flows > conceptual explainers.
  5. The fix: connect code repository changes to a documentation review signal.

Promptless connection: Promptless provides the detection layer between code changes and docs updates that DevRel teams are missing.

File

src/content/blog/technical/developer-relations-docs.mdx

This is an AI-generated draft and needs human review before publishing.


Generated by Claude Code

…s the Easy Part

Keyword: developer relations docs
Generated by edu campaign skill
@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
promptless-docs Ready Ready Preview, Comment Jun 19, 2026 4:12pm

Request Review

@InlinePizza

Copy link
Copy Markdown
Contributor

Closing this one. Here is the reasoning.

This targets src/content/blog/technical/developer-relations-docs.mdx, a path that has been occupied since #815 published "Developer Relations Docs: Why They Go Stale and Who Should Own Them" on 2026-08-04, so it is an add/add collision rather than a new page. The creation-versus-maintenance frame, the two-audiences section, and the "where DevRel teams learn about broken docs" section all land on ground the published article already holds, in its AI section and its drift-detection paragraph.

Two pieces here were doing work the incumbent was not, and both are now in the article via #865:

  • Your breakdown of which content types drift fastest. The published page only had a binary conceptual-versus-procedural split. Your version turns that into something a team can act on: quickstarts carry the most traffic and the most exposure, code samples break with every SDK change and a sample that does not run casts doubt on every other page, authentication flows change rarely but break every existing integration, and conceptual pages can sit on a quarterly cycle. The differentiated cadence is the part that makes it operational, and I kept it.
  • "Map your docs to your API surface," including the point that a spreadsheet is enough to start. The incumbent prescribed triggers and automated monitoring but never the page-level dependency map that makes a trigger actionable. It is now a fourth explicit item in the ownership model, since a trigger only helps if the owner knows which pages to open.

What I dropped, and why:

  • The 65% AI-context statistic attributed to "a 2026 AngelHack report" has no link. The published article already carries the 65% claim, so attaching a bare source name to it would have meant manufacturing a citation rather than sourcing one.
  • The HelpSite "most teams allocate zero hours for maintenance" finding is also a bare source name with no link.
  • The "four to eight user-facing changes per week, each touching two to five articles" math is unsourced. Worth noting that the same claim showed up in content: API Documentation Automation: Why Generation Is Only Half the Problem #508 and was flagged as unsupported there too, so it may be circulating between drafts.
  • The closing claim about companies with the highest developer satisfaction scores is unsourced and names no one.

Salvage PR: #865. The content-type risk ordering was the most useful thing in this draft and it survived intact.

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.

2 participants