问 AI 就好了,干嘛要写文档?

  1. 文档是结构性的知识体系,而 AI 是片段式的应答。AI 擅长回答“怎么做”,但“这样做背后的取舍和历史”、“整个系统的设计理念”等复杂的结构性内容,通常它不会主动告知你。取决于你的提问。
  2. AI 给你的答案,是针对你提问上下文的局部解,但不一定是团队、领域、行业的全局最优解。有经验的提问者才能触发高质量的答案。
  3. AI 的知识有限于它接收到的内容。有些冷门知识以及踩坑经验,只存在于个人博客,而非产品手册和技术文档。
  4. 写文档不是为了今天找答案,而是为了把当时的历史、判断、决策、经验记录下来以供未来快速理解。还原当时我为什么决定这么做。

订阅

推荐订阅 Weekly Report。每周一获取每周总结。
订阅方法:点击 Github 右上角的 watch 按钮。

提醒

  1. 在网页端,建议搜索英文用最上方的搜索框,体验比较好。搜索框不支持中文。建议搜中文用浏览器自带的搜索功能。
  2. 文章不保证正确,请自己判断对错。如果你有不同意见,欢迎到 Discussions 提出意见。

内容约定

所有文件一旦创建就不会改变路径,以保证永久链接。
文章内容可能随时会改动。

部分外部链接会引用 archive.today 以及 archive.org 的链接,以保证永久链接。永久链接需要挂代理浏览。

部分外部链接使用原链接的考虑因素有:

  • 原文内容会更新,比如 wiki 类型的文章。
  • 原链接很稳定,即使变动也会有重定向到最新的内容链接。
  • Stack Exchange 其下网站都用原链接。
  • 指向 Github Issue/Disussion/PR/Code 的都用原链接。
  • RFC 文档都使用 https://www.rfc-editor.org 的链接。

反馈问题或建议

本项目不接受 Pull Request。如果你有什么好的想法,或者改进的建议,请使用 Discussions 与我探讨。

建议 Star 本项目。不要 Fork,这没有意义。