惯性聚合 高效追踪和阅读你感兴趣的博客、新闻、科技资讯
阅读原文 在惯性聚合中打开

推荐订阅源

Forbes - Security
Forbes - Security
The Register - Security
The Register - Security
G
Google Developers Blog
罗磊的独立博客
WordPress大学
WordPress大学
L
LangChain Blog
博客园 - 三生石上(FineUI控件)
Recorded Future
Recorded Future
Microsoft Azure Blog
Microsoft Azure Blog
Google DeepMind News
Google DeepMind News
大猫的无限游戏
大猫的无限游戏
MongoDB | Blog
MongoDB | Blog
小众软件
小众软件
Recent Announcements
Recent Announcements
T
Tailwind CSS Blog
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
云风的 BLOG
云风的 BLOG
Apple Machine Learning Research
Apple Machine Learning Research
酷 壳 – CoolShell
酷 壳 – CoolShell
钛媒体:引领未来商业与生活新知
钛媒体:引领未来商业与生活新知
F
Full Disclosure
The Cloudflare Blog
B
Blog RSS Feed
S
Schneier on Security
T
Tenable Blog
人人都是产品经理
人人都是产品经理
Engineering at Meta
Engineering at Meta
T
Tor Project blog
N
Netflix TechBlog - Medium
T
Threatpost
NISL@THU
NISL@THU
Stack Overflow Blog
Stack Overflow Blog
N
News | PayPal Newsroom
N
News and Events Feed by Topic
aimingoo的专栏
aimingoo的专栏
博客园 - 叶小钗
P
Privacy & Cybersecurity Law Blog
C
CERT Recently Published Vulnerability Notes
Last Week in AI
Last Week in AI
M
MIT News - Artificial intelligence
C
CXSECURITY Database RSS Feed - CXSecurity.com
P
Privacy International News Feed
博客园 - 【当耐特】
Help Net Security
Help Net Security
The Hacker News
The Hacker News
Hugging Face - Blog
Hugging Face - Blog
TaoSecurity Blog
TaoSecurity Blog
S
Secure Thoughts
C
Cisco Blogs
CTFtime.org: upcoming CTF events
CTFtime.org: upcoming CTF events

DEV Community

Authentication Security Deep Dive: From Brute Force to Salted Hashing (With Java Examples) Why AI Systems Don’t Fail — They Drift Spilling beans for how i learn for exam😁"Reinforcement Learning Cheat Sheet" I Replaced Chrome with Safari for AI Browser Automation. Here's What Broke (and What Finally Worked) How Python Borrows Other People's Work The $40 Architecture: Processing 1 Billion API Requests with 99.99% Uptime Vibe Coding: A Workflow Guide (From Zero to SaaS) Most webhook security guides protect the wrong side. The scary part is delivery. Headless CMS for TanStack Start: Build a Blog with Cosmic EU Age Verification App "Hacked in 2 Minutes" — What Actually Happened Comfy Cloud’s delete function does not actually remove files Running AI Models on GPU Cloud Servers: A Beginner Guide Event-driven media intelligence with AWS Step Functions and Bedrock I scored 500 AI prompts across 8 quality dimensions — here's what broke How to Call Google Gemini API from Next.js (Free Tier, No Backend Needed) The Portal Protocol: Reclaiming Human Connection in the Age of AI How to Fix Your Team's Scattered Knowledge Problem With a Self-Hosted Forum Intro to tc Cloud Functors: A Graph-First Mental Model for the Modern Cloud Designing Multi-Tenant Backends With Both Ownership and Team Access I Built a Neumorphic CSS Library with 77+ Components — Here's What I Learned PostgreSQL Performance Optimization: Why Connection Pooling Is Critical at Scale Cómo construí un SaaS multi-rubro para gestionar expensas en Argentina con FastAPI + Vue 3 🚀 I Built an Ethical Hacking Scanner Tool – Open Source Project I Replaced /usage and /context in Claude Code With a Single Statusline A Pythonic Way to Handle Emails (IMAP/SMTP) with Auto-Discovery and AI-Ready Design I Collected 8.9 Million Polymarket Price Points — Here's What I Found About How Markets Really Move EcoTrack AI — Carbon Footprint Tracker & Dashboard Everyone's Using AI. No One Agrees How. 5 self-hosted ebook managers worth trying in 2026 Building Your First AI Agent with LangChain: From Chatbot to Autonomous Assistant Common SOC 2 Failures (Real World) Stop Vibe-Checking Your AI App: A Practical Guide to Evals How to Use SonarQube and SonarScanner Locally to Level Up Your Code Quality Your Next To-Do App Is Dead — I Replaced Mine with an OpenClaw AI Sign a Nostr event in 60 lines of Python using coincurve — no nostr-sdk, no nbxplorer, no rust toolchain ITGC Audit Explained Like You’re in Big 4 Patch Tuesday abril 2026: Microsoft parcha 163 vulnerabilidades y un zero-day en SharePoint Stop scraping everything: a better way to track competitor price changes Listing on MCPize + the Official MCP Registry while routing payments OUTSIDE the marketplace — how I kept 100% of my x402 revenue Building an AI-Powered Risk Intelligence System Using Serverless Architecture Why We Ripped Function Overloading Out of Our AI Toolchain Testing AI-Generated Code: How to Actually Know If It Works SaaS Churn Is Killing Your Business. Here Is What to Do About It (Without a Support Team) The Speed of AI Is No Longer Linear - And Self-Improving Models Are Why How to Implement RBAC for MCP Tools: A Practical Guide for Engineering Teams From Standard Quote to Persuasive Proposal: AI Automation for Arborists I built a CLI that scaffolds complete multi-tenant SaaS apps Axios CVE-2025–62718: The Silent SSRF Bug That Could Be Hiding in Your Node.js App Right Now The dashboard that ended our friendship Data Pipelines Explained Simply (and How to Build Them with Python) The Hidden Cost of AI Systems Nobody Talks About. undefined vs undeclared, and how typeof behaves Switching from file-based jobs to NATS/Kafka in Rust without changing code io_uring Adventures: Rust Servers That Love Syscalls Why Agentic AI is Killing the Traditional Database The POUR principles of web accessibility for developers and designers Quantum Neural Network 3D — A Deep Dive into Interactive WebGL Visualization How To Install Caveman In Codex On macOS And Windows Automation Pipeline Reliability: Why Your Workflow Breaks When Nobody Is Watching I Built an 'Open World' AI Coding Agent — It Works From ANY Folder From Freelancing to Product: A Tech Service Company's SaaS Transformation China's AI Giants: Adding Tencent Hunyuan & ByteDance Doubao to AI University (74 Providers) On the Vibe Coders and Their Lies clerk: Auto-Summarize Your Claude Code Sessions AI Weekly — 2026/04/10–04/17 | The Model Lockdown Is Here, but the Toolchain Is the Real Battleground AI 週報 — 2026/04/10–2026/04/17 模型封鎖潮來了,但工具鏈才是真戰場 Maybe this is how Open-Source apps are born... 🚀 Fine-Tune LLMs with LoRA and QLoRA: 2026 Guide tRPC v11 + Next.js App Router: End-to-End Type Safety Without the Boilerplate ShadCN UI in 2026: Why I Stopped Installing Component Libraries and Started Owning My Components SaaS Billing in React Server Components: Stripe + Supabase Without a Single `useEffect` Join our DEV Weekend Challenge — $1,000 in Prizes Across TEN winners! Submissions Due April 20 at 6:59 AM UTC. Implementing FSRS Spaced Repetition in Flutter + Supabase — Adding Memory Science to an AI Learning App "I Texted My Localhost From the Train — Claude Code Fixed the Bug Before I Got Home" I Built a Sales Prep AI and It Went Deeper Than Expected Design to Code #2: One JSON, Eleven Outputs Solving the 100M-Row Problem: A Summary Table Pattern for High-Volume Push Notification Logs Flutter Web With Wasm: What Actually Changes For Developers I Built 50 Royalty-Free Soundtracks for My Side Project in a Weekend Using AI Music Generation The Vibe Coding Security Checklist: 7 Things to Check Before You Ship Stop Letting Googlebot Guess Fix Your React App's SEO Right Desconstruindo o Streaming do LinkedIn: Como Criar um Engine de Extração de Vídeo de Alta Performance com HLS e FFmpeg (EDA Part-1) EDA (Exploratory Data Analysis) Explained With Real Life — Why Looking at Your Data Is the Most Important Step in Machine Learning Brand Relationship Management at Scale: Our 4-Touch Outreach System for 200+ Brands Why String.fromEnvironment() Might Return an Empty String in Dart JGuardrails 1.0.0 — Hardening Java LLM Apps Against Jailbreaks, Toxicity, and Prompt Injection Plan and Schedule a Full Week of Threads Content From One Claude Conversation Coding Cat Oran Ep3, Five Tables Changed Everything Updated: BFF Pattern I'm done watching freelancers get buried by 200 proposals. So I'm building the alternative. This is my first post BFS Algorithm in Java Step by Step Tutorial with Examples Tracking LLM Pricing Monthly: An Open Dataset for 22 AI Models How We Measure Content ROI on a Comparison Site: Revenue Attribution Without Perfect Data Introducing Nova AI Ops: The AI-Native Operating System for SRE Teams I built a free desktop video downloader for Windows — Grabbit How Talkie OCR Helps Vision-Impaired & Dyslexic Users Read the World Around Them VRCFaceTracking安装和iPhone面捕配置教程,有bug Even CrowdStrike Can't See Your Agents The Automation Gold Rush: What n8n Workflows and Claude Are Opening Up for Developers Right Now
When the Docs Lie
Ian Johnson · 2026-05-21 · via DEV Community

There is one thing worse than a codebase with no documentation: a codebase with documentation that used to be correct.

The README that explains how to set up the development environment, with three commands that no longer exist. The architecture diagram from 2022 that shows services your team has since deleted, alongside two that have been renamed. The API reference whose example payloads have the wrong field names. The onboarding doc whose first link is broken. All of these existed for a reason. All of them, having outlived the world they described, are now lying to anyone who reads them.

Stale documentation is not a small problem. It is worse, in specific and measurable ways, than no documentation at all. And agents make the situation more acute, because agents read documentation eagerly and trust it.

Why this is worse than nothing

A codebase with no documentation produces honest uncertainty. New contributors know they have to learn the system from the code. They ask questions. They read until they understand. The absence is visible and it sets the expectation correctly.

A codebase with stale documentation produces confident wrongness. New contributors read the doc and believe they understand. They proceed on assumptions that the doc made true at some point in the past. They write code that fits those assumptions. The wrong work ships before anybody notices that the doc was wrong.

The dynamic is the same with agents, except faster. An agent reading a doc that describes a function signature that no longer exists will produce calls to that signature. The build fails, sometimes. Or worse, the agent constructs plausible code based on the doc and produces something that compiles but does not work, because the actual function expects different arguments.

The "no docs" case is easier to navigate than the "stale docs" case, every time. Absence is honest; staleness is not.

Why docs go stale

Documentation goes stale because it lives separately from the code it describes, and because nothing forces the two to stay in sync.

A function changes. The developer updates the function. The doc that describes the function lives in a wiki, in a Notion page, in a separate markdown file in a docs/ directory, in a comment three layers of indirection away from the function itself. Updating it requires a separate action. The separate action is easy to skip. Most of the time, it is skipped.

The doc continues to describe the old version of the function. New readers, human and agent, pick up the wrong information. The drift compounds across releases until the doc and the code are different artifacts describing different systems.

The teams that have functional documentation have one of two properties: either the documentation is generated from the code (so it cannot drift), or the documentation is treated as part of the code (so changes to one require changes to the other).

What "generated" can do

The strongest documentation is documentation the team does not write by hand.

API references generated from OpenAPI specs or schema definitions. If the schema is correct, the doc is correct. The schema is correct because the running service uses it.

Type signatures rendered as docs. Languages with good type systems can produce reference documentation that reflects the actual code. The doc and the code cannot disagree because the doc is the code.

Examples extracted from tests. The test runs. The test demonstrates how the function is used. The example in the doc is the test. When the function changes in a breaking way, the test breaks, and the example is no longer in the doc.

The shift toward generated docs is the cheapest large win available for documentation accuracy. It does not cover everything: there is still hand-written prose explaining concepts, walkthroughs, decision records. But it removes the largest source of staleness, which is API reference material that drifts because nobody is paid to keep it in sync.

What "treated as code" means

For everything that cannot be generated, the practice is to treat documentation changes the same way you treat code changes.

Docs live in the repository, near the code they describe. A README per significant directory. Comments that explain non-obvious choices. Decision records in docs/decisions/. The PR that changes behavior is the same PR that updates the relevant docs. The reviewer's job includes catching the case where the doc was not updated.

The mechanical version of this is to add a checklist item to the PR template: "Did this change require a doc update?" The author confirms or explicitly says "no." A reviewer who suspects a doc update was needed can push back, just like they would on a missing test.

The deeper version is to delete docs aggressively. A document that nobody is willing to maintain is a document that is going to go stale. If the team will not commit to keeping it current, the document should not exist. It is better to have a one-paragraph note that links to the code than to have a long doc that nobody reads and nobody updates.

How the agent fits in

The agent's relationship with documentation is asymmetric. The agent reads docs into context at the start of a session. The agent does not, by default, update docs as it goes.

The way to fix this is to make documentation updates part of the change. The same rule that goes into AGENTS.md for any other concern: "If you change a function's behavior, signature, or location, update any documentation that references it." The agent, given that rule, will produce diffs that touch both files. Without the rule, the agent will produce diffs that touch only the code, because the code is where the failing test will surface.

A related rule is worth adding: "If documentation in this repository contradicts the code, the code is the source of truth. Update the documentation to match, or flag the discrepancy in a comment for human resolution." The agent encountering stale documentation should not pattern-match against it; it should treat the code as authoritative.

First steps

If you have an accumulation of stale docs and you want to start fixing it:

Audit your top-level README today. Walk through every command in it. Delete or fix every one that does not work. The README is the document most readers see first; making it accurate is the highest-leverage change.

Find your most-linked-to doc. One that gets referenced in onboarding, in PR comments, in Slack threads. Walk through it. For each claim, check whether the code still matches. Either fix the doc or delete the claim.

For your API reference, if you have one and it is hand-written, switch to generated. OpenAPI from your routes, type-generated docs, whatever fits. The work to switch is real; the work it saves over the next year is larger.

Add to your PR template: "Did this change require a doc update? If yes, which docs were updated?" The question forces a moment of thought. Some PRs will say "no" and be correct. Others will discover, on being asked, that the answer was actually yes.

Add one rule to AGENTS.md: "When you change behavior, signatures, or names, update any documentation that references them in the same change. If you find documentation that contradicts current code, flag it explicitly in the PR description."

The most valuable documentation is the documentation you can trust. The work to make documentation trustworthy is small, ongoing, and almost never urgent. Doing it anyway is what separates teams whose docs are an asset from teams whose docs are a trap.