乐于分享
好东西不私藏

架构文档过期的世界难题,被他解开了!!

架构文档过期的世界难题,被他解开了!!

你有没有过这种体验

入职第一天

前辈丢给你一份 ARCHITECTURE.md

说「这是咱们的架构文档先看看」

你打开

发现最后更新时间是两年前

里面写的模块拆分

跟代码里实际的结构

已经是两回事了

这不是某个团队的懒

架构文档过期是普遍现象

代码天天改

文档没人动

最后变成一份「技术债化石」

不是不想维护

是维护成本太高

人扛不住

今天刚开源的一个项目

叫 Architecture Wiki

做的就是这件事

让架构文档不再过期

它是什么

Architecture Wiki 是一个 Agent Skill

你把它装到 AI 编程助手里

(Codex、Claude Code 等)

它就会为你的代码仓库

自动生成一份架构 wiki

并且在代码变化时持续维护

仓库地址⬇️

https://github.com/Suge8/architecture-wiki

核心设计很巧妙

同一份文档

三个消费者各取所需

人看:等距城市地图

打开网页

你的整个项目变成一张

「等距城市地图」

每个模块是一栋建筑

模块间的调用关系用连线表示

调用链可以像放电影一样

按入口逐拍播放

每个模块单独一页

用人话写清楚它干什么

不用啃 Markdown

不用翻目录

一眼看到全貌

AI 看:每条论断都带收据

wiki 里的每一条描述

都带着「出处」

引用了哪个文件

点名了哪个函数

记着内容哈希

AI agent 一读这份 wiki

就能理解项目全貌

不用从零爬代码

这意味着什么

你让 AI 帮你改代码

它不用先花半小时读项目

直接看 wiki 就知道

模块边界在哪

调用链怎么走

CI 看:代码一变立刻报过期

这是最关键的一环

代码改了

一个叫 verify.mjs 的零依赖脚本

(只要 node + git)

会告诉你哪一页过期了

并打印对应的 diff

判断过期不靠 AI 的自觉

靠脚本

AI 会忘,脚本不会

网页本身只是 wiki 的渲染产物

删了随时重建

真正有信息量的是那份带出处的 wiki 文档

顺手送一份全仓体检

建 wiki 的同时

它会跑一次全仓扫描

查四类问题

没人引用的死文件

循环依赖

又大又常改的高危文件

断裂的 import

每条发现都复核过才进报告

不拿误报吓人

有问题的模块在地图上顶着警示标

点一下直达报告对应小节

怎么用

安装,把下面这句发给你的 AI agent

Install the skills from https://github.com/Suge8/architecture-wiki

建 wiki

用 architecture-wiki 给这个仓库建架构 wiki

代码变了之后同步

用 architecture-wiki 同步架构 wiki

要求 Node.js 18+ 和 git

JS/TS 仓库的依赖图分析另需 bun 或 npm

Skill 为显式调用设计

不会在你不知情的时候自动跑

适合谁

有代码仓库

用 AI 编程助手

被架构文档过期折磨过的人

JS/TS 支持最成熟(实战验证)

Go、Rust、Java/Kotlin 也有支持

其他语言走降级路径

中英双语同仓发布

安装时按对话语言自动选择

作者 Suge8,Apache-2.0 协议

今天就开源首发

在线 Demo 用的是一个真实项目

(浏览器侧边栏 Agent Taber)做的

不是玩具

值得直接去看效果

https://suge8.github.io/architecture-wiki/demo/

一句话总结一下:

AI 负责读懂和改写

脚本负责盯梢

架构文档终于不用靠人自觉了

天才!