代码写得再溜,要是没人说清楚当初为什么要这么设计
现在的工程圈里有个挺离谱的论调,觉得既然 AI Agent 都能直接读源码和 OpenAPI 规范了,那程序员还得费劲写文档干嘛?反正代码更新比翻书还快,写出来的文档转头就过时,简直是在浪费人力成本。
下一篇
ContextVault →
作为移动端开发,我天天盯着那点 API 调用成本和接入效率,说实话,这种“去文档化”的想法挺危险的。代码和 Spec 只能告诉你系统“怎么跑”,但它们永远解释不了“为什么这么跑”。
Agent 确实牛,模式匹配和语法执行没得说,但它理解不了架构设计的权衡(Trade-off),更读不懂那些为了兼容老版本留下的“坑”。如果只给机器喂原始代码,它只会机械地执行,一旦遇到边界条件,出来的全是“逻辑垃圾”。
我之前试过让 LLM 自动生成文档,结果发现如果不加干预,它会陷入一种“用幻觉描述幻觉”的死循环——生成的文档看似专业,实则全是废话。要解决这个问题,不能完全甩手给 AI,得用一种“动态生成+人工审计”的思路。
我总结了一个专门用来辅助梳理设计意图(Design Intent)的 Prompt,不是让它单纯翻译代码,而是逼它去思考背后的逻辑。你可以把它集成到你的 CI/CD 或者代码评审流程里,别让文档变成一堆没用的 Slop。
# Role: Senior Software Architect & Intent AnalyzerContext:
You are reviewing a code change. The goal is not to describe what the code does (the code already says that), but to capture the intent, rationale, and architectural constraints.Task:
Analyze the provided code diff and the surrounding context. Generate a "Design Rationale" entry for our internal documentation.Output Format (Strict):
💡 Intent & Rationale
Why this change? (Explain the business logic or technical debt being addressed)
Decision Trade-offs: (Why this approach instead of alternatives? Mention performance vs. readability vs. scalability) ⚠️ Edge Cases & Constraints
Hidden Gotchas: (Any specific historical context or legacy edge cases this code interacts with?)
Agent Guardrails: (Crucial instructions for any AI agent or developer interacting with this module) Input Data:
[Insert Git Diff or Function Context Here]说到底,现在的瓶颈不在于 AI 生成能力不够,而在于我们缺乏一套衡量知识库“可信度”的标准。在大家还在为 AI 生成的内容是否靠谱而纠结时,守住那点 Markdown 文件的底线,让机器也能读懂“弦外之音”,才是最务实的做法。
全部回复 (6)
向
向量检索中
新手
1小时前
文档这块儿确实是个坑,我之前写项目总觉得写 README 是浪费时间,后来发现没 documentation,新加入的 dev 根本理解不了当时的 design rationale,纯靠猜代码逻辑真的会累死。
0
卷
卷不动了呢245
新手
1小时前
我也踩过这坑,上次接手个旧项目,对着几千行逻辑代码抠了三天,真不如当时多花半小时写个设计文档。你当时是怎么解决这种沟通断层的?
0
D
L
Backboard IO 听起来挺有意思,他们在底层架构上做了哪些优化吗?比起单纯堆算力的巨头,我更关心这种专注解决特定痛点的初创公司在成本控制上能不能玩得过硅谷那帮玩家。
0
A
凌晨两点看那种没文档的屎山代码,真没几个能靠 Agent 瞬间理清逻辑的。我带队做工程落地时,如果文档缺失,哪怕模型推理能力再强,维护成本也会因为理解偏差直接爆炸。
0
接