Documenting Code Nobody Remembers: A Git-History Draft Pipeline
A recurring theme in this week's DEV discussions: AI turned every developer into a reviewer, but nobody wrote the contract between the model's draft…
Latest News
⚑ Report a ProblemTech news from the best sources
All topics
AI
Gear
News
Tech
agents
ai
api
architecture
automation
beginners
career
database
devchallenge
devops
javascript
llm
machinelearning
mcp
opensource
performance
productivity
programming
python
react
security
showdev
testing
tutorial
typescript
webdev
AI Drafted the Docs. Your Job Is Decisions, Not Prose.
AI Drafted the Docs. Your Job Is Decisions, Not Prose. When a language model drafts documentation, the bottleneck shifts from writing to reviewing,…
Doc Drift Is a Bug: A Claim-Checking Loop for Model-Generated Docs
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 Docs Draft Pipeline: What an AI May Write and What You Must Own
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
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…
Release notes are not release documentation: a reader-task coverage method
A release note can be completely accurate and still leave an integrator unable to use the release. “Webhook retries now use exponential backoff and…
The AI Followed the Instructions. The Documentation Still Fell Apart.
AI disclosure: This article was generated with the assistance of AI based on my own development experience, observations, and ideas. I reviewed and…
Embed Charts in Markdown Without Chart.js: SVG, Data URIs, and What Actually Works
Markdown is great until you want a real chart in a README or docs site. Most people reach for a screenshot, a hosted PNG, or a heavy client library.…
Which Markdown editor to choose
Disclosure: I work on Notula, which is the last section of this article. Everything before it is about the category. A WYSIWYG Markdown editor hides…
The COBOL Problem
Originally published on adammonago.com . The COBOL Problem names a knowledge pattern. The language is a metaphor. The store still runs. The interpre…
Ruby Pathname Moved to Core, Documentation Upgraded
In release 4.0, the Ruby Powers-That-Be have brought class Pathname into the Ruby core. This is a Very Good Thing. Through its many instance methods…
grow-hack: An AI Pipeline That Turns Any GitHub Repo Into Professional Docs in Under a Minute
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…
Column Comments in PostgreSQL and MySQL: How to Document Columns Without a Migration
Disclosure: I build Schemity , a desktop ERD tool - this post is from our blog and uses it for the examples. TL;DR: The database has a built-in plac…
Your Migration Guide Is Already Wrong
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…
Deprecation Doesn't Reach the Copies
Originally published on hexisteme notes . I keep my operating judgment in small, versioned files — one file per decision, each with a status, a list…
Writing evidence-linked docs exposed two missing regression tests
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…
Internal vs. External Documentation: What Belongs Where
Originally published at https://ninadpathak.com/articles/internal-vs-external-documentation/ . Internal documentation helps your team operate the sy…
Markdown Tricks for Cleaner Docs
Markdown Tricks for Cleaner Docs Markdown is everywhere: READMEs, docs, comments, even this very post. But most people stick to the basics: headings…
What Is Technical Documentation, and What Should It Include?
Originally published at https://ninadpathak.com/articles/what-is-technical-documentation-and-what-should-it-include/ . Technical documentation is th…
Technical Documentation Best Practices, Tested on Real Developer Docs
Originally published at https://ninadpathak.com/articles/technical-documentation-best-practices-tested-real-developer-docs/ . A documentation page c…
Seven things I got wrong about my own project in one day, and what caught each one
One of my checkers scans every draft I have written for wording that overstates what the code actually does. I ran it across everything, it came bac…
Technical Documentation Template: Build Product Docs With a Tested Structure
Originally published at https://ninadpathak.com/articles/technical-documentation-template/ . Creating documentation often forces several decisions a…
A Second Brain Your AI Agent Can Read
Background There are so many details we need to remember in life. Recently I've been working on a legacy project that was written years ago with no…
GFM vs CommonMark vs Pandoc Markdown: Syntax Compared
Markdown looks like one language until the same file renders differently on GitHub, Hugo, Obsidian, or Pandoc. And the problem is not that Markdown…
Markdown Tricks for Cleaner Docs
Markdown Tricks for Cleaner Docs I've written a lot of documentation over the years, and I've learned that Markdown is more powerful than most peopl…
How I Turned a Technical Writing Team Upside Down...Or, Downside Up?
Every time I think about what happened to me that one beautiful day, I still get goosebumps because that was my whole career shift. I’m sure a lot o…
Structured authoring without XML - how it works
What is structured authoring? Structured authoring means writing content as reusable, semantic building blocks instead of free-form documents. The i…
How dotdotgod Query Finds Relevant Documents from a Natural-Language Question
A documentation table of contents is the fastest retrieval method when an agent knows the relevant role and path. A user's question may use differen…
SSMS Database Diagrams: Your ERD Is Trapped Inside the Database It Documents
Disclosure: I build Schemity , a desktop ERD tool - this post is from our blog and uses it for the examples. TL;DR: SSMS keeps every database diagra…
Code First, Specs After: A Practical Guide to AI-Driven Development
1. Introduction In an era where AI agents like Claude Code and GitHub Copilot have become commonplace, the development landscape has undergone a dra…