Measure the Executable Share of a Docs Page Before Letting a Model Draft It
Liquid syntax error: Unknown tag 'endraw'
Последние новости Testing & QA от Tech News
Liquid syntax error: Unknown tag 'endraw'
This article is AI-generated. Every team has things that only one or two people know. How to restart the label printer when it jams. Which customer…
Your README is a promise nobody tests. Setup instructions rot silently. You rename a script, add an env var, switch a package manager, and the quick…
Models may draft tutorial narration, but they must not invent the samples that the narration claims to demonstrate. A human-owned fixture ledger sho…
As I've had a pretty busy period, I haven't had the chance to post anything new here, and I only managed to get a few things done on the actual codi…
How working on my own communication led me to build Concision, a portable skill for AI agents. I’ve received the same kind of feedback more than onc…
Schema documentation used to be the thing teams promised to do "next sprint" and then never did. In 2026, that excuse doesn't hold up. Warehouses ar…
Joining an unfamiliar codebase, what you want isn't more code — it's a wiki that explains how the thing actually works: which modules exist, where t…
Configuration reference pages fail when generated prose is treated as the source of production defaults, secret classes, or deprecation windows. A p…
Config documentation fails most often when a generated catalog silently absorbs production promises that nobody reviewed. Parser extraction can list…
Your README is full of code — shell commands, config snippets, >>> sessions, example output. And unlike the rest of your codebase, none of…
A table in my spec cited a source file by line number, 23 rows of it. Every one was off by one or two. The coverage check next to it had been green…
A reader searches for help opening a puzzle box. The result supplies the answer in its preview, includes a later character reveal in the heading, an…
Generated reference docs stay trustworthy when a generator may write only restatable files under an allowlisted path. Support windows, uptime figure…
You join the afternoon standup and someone demos a chatbot that already talks to staging data. Token cost looked like zero, so the spike used a free…
Introduction The commit message is something we write very frequently during the development process. It summarizes the changes made after completin…
Model-drafted documentation is useful only when every generated claim maps to a file the repository already owns. Sentences without a source become…
Generated documentation stays safe only when draft authority follows the product lifecycle, not the writer's convenience. Models may draft experimen…
AI code assistants have made documentation fast to produce and easy to ignore. The issue is not speed; it's trust. Models can write a polished docst…
Two side projects, one developer, an AI assistant on both. You work on them when you can and when you feel like it, for fun. And precisely because i…
Generated docs fail most often at the boundary between prose and code, where a flag name or a signature silently disagrees with the source. A free-t…
The most common documentation failure is not a weak prompt or a lazy writer; it is the absence of a clear boundary between machine-draftable content…
Five Files, No Record of Which Came First You started a project on Monday. By Thursday you have five files: a research document, a spreadsheet of da…
A release note can be completely accurate and still leave an integrator unable to use the release. “Webhook retries now use exponential backoff and…
Every developer has been there: you clone a promising repository, and the README is either missing, three years stale, or says "docs coming soon." E…
James Coombs is a design engineer who replaced a migration guide with 49 JSON data files and a handoff playbook. Engineers on four other teams migra…
This is a crosspost of the canonical version on GitHub . 1. Problem I run agent-cost , a small open-source CLI that reads local Claude Code / Codex…
Originally published at https://ninadpathak.com/articles/internal-vs-external-documentation/ . Internal documentation helps your team operate the sy…
Originally published at https://ninadpathak.com/articles/what-is-technical-documentation-and-what-should-it-include/ . Technical documentation is th…
Originally published at https://ninadpathak.com/articles/technical-documentation-best-practices-tested-real-developer-docs/ . A documentation page c…