标签: #documentation
关于 GPU、LLM、MLOps、Kubernetes 以及心态的文章 · 2 篇
为什么 Diátaxis 会被误解成四个文件夹 —— 一篇文档里混两种模式为什么会塌
Diátaxis 把文档分成教程、操作指南、参考、说明这四类。可大多数团队建完四个文件夹就算落地完毕,真正的问题原封不动地留在那里。因为真正的失败不在分类,而发生在一篇文档里混用四种模式的时候。本文从这套框架赖以成立的两条轴出发,重新梳理混起来为什么会塌,并整理了以段落为单位作判定的罗盘,以及这周就能跑起来的工作循环。
2026-08-09 · 12 分钟阅读 #documentation#diataxis#technical-writing#developer-experience#information-architecture文档里的代码截图从什么时候开始撒谎 —— 把图片做成构建产物
手动截图再贴进文档的代码图,是一件没有源码的产物。代码变了图还在原地,于是从某一刻起它开始悄悄展示错误的东西。用 goshot 这类 CLI 把图片改成由一行命令生成,它就能跟着文档一起重建,而在那一刻,遮蔽敏感值和统一样式也一并被抬进了可评审的范围。文中也写明了哪些是我确认过的功能,哪些是我并没有亲自跑过的。
2026-08-09 · 12 分钟阅读 #documentation#developer-tools#cli#ci#automation