My Project Docs Aren't For Humans Anymore. They're For an Agent That Re-Reads Them Every Session.
I used to write docs/ the way I was taught: prose paragraphs, a little context, a "why we did this" narrative you'd hand to a new hire. Then I noticed…
Latest News
⚑ Report a ProblemTech news from the best sources
All topics
- игры
AI
Gear
News
Tech
agents
ai
api
architecture
automation
beginners
career
claude
devchallenge
devops
javascript
llm
machinelearning
mcp
opensource
performance
productivity
programming
python
react
security
showdev
tutorial
typescript
webdev
Great API docs don't lead with a parameter table
Hot take: complete API docs are not the same as good API docs. Everyone thinks great docs means listing every endpoint, every parameter, every respons…
A low-tech repo context pattern for AI coding agents
I have been trying to keep repository context useful for AI coding agents without turning it into a large prompt file or depending on a specific vendo…
I Reviewed 10 AI Startup Documentation Sites. Here Are the 7 Mistakes I Kept Seeing.
Documentation is often the first product a developer experiences. Before they see your architecture, your engineering culture, or your code quality, t…
Why Developers Don't Read READMEs
Developers are the world's most efficient skimmers. When someone lands on your repo, they're running a rapid mental triage: What does this do? (5 seco…
GSoC 2026 with webpack | weeks 3 to 6 - a lot happened
Hey, ryzrr back 🙌. a lot shipped since the last post so let's get into it. what i shipped feat: add governance docs fetcher under pages/contribute/gov…
GitHub for writers: Navigating pull request reviews
In the previous post on GitHub for writers: Branches and Pull Requests , you learned how to create branches, commit changes safely, and open pull requ…
vike-vue-content: A Zero-Boilerplate Docs Framework Built on Vike + Vue
If you've ever built a documentation site with Vue, you know the drill: Write a +Page.vue for every route Manually wire up Markdown loaders Set up cod…
🚀 Released a New Version of jsdoc-scribe
Keeping documentation updated is difficult, especially when projects continue to grow. To make this easier, I've been building jsdoc-scribe, an open-s…
Your README Is More Than Documentation
Most open source projects don't fail because of bad code. A few years ago, I thought a good project would naturally attract users if the code was soli…
How to Fix Messy Markdown from Notion or Obsidian
If you’ve ever exported from Notion or Obsidian, you know the pain: extra whitespace everywhere, empty links, inconsistent heading styles, and stray H…
Как выбрать эмбеддинг для проекта
Эмбеддинги (иначе говоря, векторные представления) — это способ представления абстрактных данных в виде набора чисел (в виде векторов, как вы могли уж…
What it takes to build docs worth reading
Treating docs as a product When documentation lives as an afterthought, it shows. Pages drift out of date, examples break quietly, and release notes s…
Humanizing Artificial Intelligence in DevOps Documentation: Making Runbooks Easier to Create and Use
The Runbook That Lied to Me at 3am The pager went off at 3:14am for a wedged OpenStack Neutron agent. I did what any tired engineer does: I opened the…
AI Documentation Tools in 2026: Mintlify vs Document360 vs GitBook — Which Turns Your Code Into Live Docs?
AI Documentation Tools in 2026: Mintlify vs Document360 vs GitBook — Which Turns Your Code Into Live Docs? If you've ever inherited a codebase with do…
Your README lies. So I built a bot that opens a docs PR every time you merge.
The README lies. Not on purpose. It was true the day someone wrote it. Then the function got renamed, the flag got removed, the env var changed, the e…
"Confluence Docs Lie. Tie Your Documentation to Code Instead."
Every team has that Confluence page. The one that was carefully written to explain what the service does, what the API looks like, what each DB column…
The Only API Documentation Template Your Team Actually Needs
Last week, I watched a senior dev spend 45 minutes just trying to figure out if an API endpoint was deprecated or not. He had to dig through Slack thr…
Green tests, broken docs. Dogfooding caught what 15 tests missed
A broken doc still renders. That is the whole reason documentation rot is so dangerous. The page looks fine right up to the moment someone clicks the …
How We Sourced a 12-Part Tech Investigation So Every Claim Survives a Hostile Fact-Check
I just shipped a 12-part video series on cloud economics - depreciation schedules, lock-in, licensing disputes, bundling cases. The kind of material w…
Architecture Drift Detection: Keep Your Code Aligned with Design
Somewhere in your organization, there's an architecture diagram that's wrong. Maybe it shows a microservice that was merged into another six months ag…
Reverse Engineer Any Database into dbdiagram.io, PlantUML, Mermaid, or QuickDBD - Then Keep Designing
Most database diagram tools stop at documentation. They connect to your database, inspect the schema, and generate a report or a picture. That is usef…
Your Terraform estate documents itself now: meet iac-cartographer
"Wait: How many Terraform repos do we actually have? And what's in them?" If that question makes you wince, this post is for you. It started as a bori…
Stop Cloning Entire Repos for Your Doc Builds
Your docs live next to your code. That's the docs-as-code promise — version control, pull request reviews, CI/CD pipelines. It works beautifully. Unti…
Docstrings vs Markdown Docs: What Should Developers Actually Write?
Every developer hits this wall eventually. You know you should document your code. You've heard the lectures. But then you're staring at your project …
Checkbox theater: how I stopped trusting my AI agent to run the checks
For context: in the previous piece , I worked through a five-dimension review framework for documentation, covering clarity, readability, style, compl…
Everyone Needs a README for Their Life
"If you don't document it, the next person inherits your confusion—and that next person is often you, six months later, in a different city, wondering…
Why Your GitHub README Diagrams Look Amateur (and the 4 Fixes That Take 10 Minutes)
TL;DR If your README diagrams look like every other open-source repo's, that's because they all use the same four defaults. Switching to theme: 'base'…
Capture the Reasoning Path, Not the Final State
Two files, one discipline, and a measured 10-13% of my Claude Code budget. A while back, mid-session with Claude Code, I typed a pushback in the kind …
Running FreeIPA on Ubuntu Using Podman
There was this consideration to replace OpenLDAP with FreeIPA in the university authentication infrastructure. The main motivation for this was to imp…