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

推荐订阅源

M
MIT News - Artificial intelligence
罗磊的独立博客
Hugging Face - Blog
Hugging Face - Blog
J
Java Code Geeks
G
Google Developers Blog
美团技术团队
让小产品的独立变现更简单 - ezindie.com
让小产品的独立变现更简单 - ezindie.com
腾讯CDC
奇客Solidot–传递最新科技情报
奇客Solidot–传递最新科技情报
T
The Blog of Author Tim Ferriss
月光博客
月光博客
B
Blog
WordPress大学
WordPress大学
云风的 BLOG
云风的 BLOG
博客园_首页
人人都是产品经理
人人都是产品经理
aimingoo的专栏
aimingoo的专栏
Y
Y Combinator Blog
Jina AI
Jina AI
S
SegmentFault 最新的问题
H
Help Net Security
博客园 - 聂微东
Microsoft Azure Blog
Microsoft Azure Blog
Google DeepMind News
Google DeepMind News

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
A single HTML file for architecture docs
Kat Laszlo · 2026-04-28 · via DEV Community

I maintain a single HTML file as an architecture board for the product I'm building. Definitions, data models, API surface, routes, changelogs, postmortems. One file, opens in a browser, shows the state of things at a glance.

I've been using it to stay oriented while developing Tanso, and it's been useful enough that I wanted to share it in case anyone else has been thinking along the same lines.

The origin was simple: I kept asking AI tools to generate structured documents (ERDs, changelog tables, postmortem writeups) and discarding them after a single look. But the output was already organized. The data was already there. The only waste was starting from zero every time.

So I stopped starting from zero and made a template: human-docs.

What's in the repo

template.html   Empty scaffold with section markers. Fork and fill.
PROMPT.md       Instructions for any AI tool to generate or update the doc.
example.html    Cal.com's architecture, fully filled in.

Enter fullscreen mode Exit fullscreen mode

How it works

Point any AI tool (Claude Code, Cursor, Codex) at your codebase with PROMPT.md as the prompt. It fills in the template. Open the result in a browser.

When something changes, you don't rebuild the whole file. The template uses <!-- SECTION:name --> markers so updates are surgical. The AI edits only the sections that are stale, leaves everything else intact. Similar to how you'd review a git diff: only what actually changed.

Over time the file compounds. Each deploy adds a changelog entry. Each bug adds a postmortem. Each migration updates the ERD. The document gets more useful the longer you maintain it.

The sections

Section Purpose
Definitions Clarify overloaded or ambiguous terms in the codebase
Data Model Tables, relationships, ERDs grouped by domain
Pages & Routes Every user-facing route and what it does
API Surface Endpoints grouped by domain
Changelog What shipped, filterable by type
Postmortems What broke, root cause, fix, prevention rule

Postmortems are the most valuable section. Changelogs record what happened. Postmortems record what not to do again.

Why HTML

HTML is self-rendering. Open it in any browser, no preprocessing needed. And because it's structured markup, an AI agent can parse it and update individual sections without regenerating the whole document. It serves both audiences (human readers, AI agents) without needing two versions of the same information.

What I'm actually thinking about

The template is the lightweight part. The more interesting part is the questions behind it.

As AI accelerates execution and one person takes on more, I think the constraint increasingly becomes the human context window. Not writing the code, but keeping track of everything across workstreams. Having a single page where I can see the architecture of a project without reconstructing it from memory has been more valuable than I expected.

And that opens up some directions I keep coming back to:

What if this auto-updated on every commit? A git hook diffs the changes, maps them to sections, and the doc stays current without anyone prompting it.

What if it replaced tools like Swagger or TypeDoc instead of sitting alongside them? The AI is already reading your codebase to fill sections. It can generate API references in the same file, next to the architectural context those tools never capture.

Is HTML even the right format long-term, or just the right format for now? It's self-rendering and structured enough for agents to parse. But if other tools need to consume the data downstream, maybe the source should be structured data with HTML as one view.

I don't have answers to these yet. But I think the questions are worth thinking about, and I wanted to put this out there in case anyone else has been working through the same stuff.

Repo: github.com/katrinalaszlo/human-docs

Open example.html to see what a filled-in doc looks like.