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…
Latest Web news from Tech News
All topics
AI
agents
ai
api
architecture
automation
aws
beginners
career
claude
database
devchallenge
devops
javascript
learning
linux
llm
machinelearning
mcp
opensource
performance
productivity
programming
python
react
security
showdev
tutorial
typescript
webdev
"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…
Introducing Truthmark 1.4.0: Git-native truth workflows for AI coding agents
AI coding agents are getting good at changing code. That creates a new problem. The code changes, but the repository often stops telling the truth. Th…
Building ARCHITECTURE.md Files That Prevent AI From Making Silent Architectural Decisions
Building ARCHITECTURE.md Files That Prevent AI From Making Silent Architectural Decisions A few weeks into our experiment with an AI coding assistant,…
I kept saying the same five things in every doc review. So I made them defaults.
In my last piece , I wrote about how AI changed my work as a technical writer. I closed with a line I keep coming back to: technical writing is shifti…
How I Documented an Entire Product in 4 Days with an AI Agent
I had 55 pages of documentation to write, 59 screenshots to capture, and a product that was still shipping features and being rebranded weeks before r…
Stop sending README files as API docs — publish a live, versioned docs site with APIKumo
We've all been there. You build an API, you're proud of it, and then someone asks: "Hey, where are the docs?" And you paste them a GitHub link to a ma…
Your Support Tickets Are a Documentation Backlog in Disguise
You know the feeling. You are deep in a debugging session, finally making progress on that memory leak, and a Slack notification pulls you out. A cust…
Capture the decision at commit-time, or lose it forever
How many times have you faced code nobody can explain anymore? A strange architectural choice. A cache TTL of 17 minutes that nobody can justify. A wo…
I stopped manually maintaining OpenAPI specs — here's what I did instead
It was a Monday morning. A partner pinged us because their integration had broken overnight. Turns out, someone had merged a PR that renamed a respons…
I Thought Portfolios Weren't for People Like Me. So I Built a Wiki Instead.
For a long time I operated under a quiet assumption: portfolios are for developers. They're for people who build things — apps, tools, open source pro…
Enterprise Architecture Diagrams That Actually Scale
Your service is down. Latency spiked to 30 seconds. You pull up the architecture wiki, desperate to trace the failure path, and find... a messy Visio …
AI Captions Are Useful, But Field Reports Still Need Human Review
AI captions can make field reporting faster. They can also create risk if teams treat them as final truth. That is the tension. In field documentation…
Levels of Python type annotations
Python has optional type annotations - also called "type hints". Like this: def entry_to_dict ( entry : Entry ) -> dict : return { ' title ' : entr…
Why we built provenance into a notes app
Notes written in the field are good at recording results and reflections, but keeping the flow that led to those results as structure is surprisingly …
From Code to Clouds: Hosting a Professional Resume on GitHub Pages(2)
Introduction In Part 1 , we successfully moved the resume from a local editor to a live URL . But an empty repository is like a house without a front …
LeafWiki Devlog #10: v0.9.0 – no more broken links, lost edits, or overwritten changes
LeafWiki - A self-hosted wiki for long-lived documentation. Built for engineers, self-hosters, and small teams. LeafWiki v0.9.0 is out. This release f…