访谈纪实:我在 Oracle 探索的“文档美学”之路
浏览:8
巴克励步
Richard Rabil分享从书虫到Oracle技术文档工程师的经历,强调文档需兼具功能与深度质量,认为AI时代视觉设计更重要,建议平衡清晰与美感,勿过度执着内容复用,并推荐相关学习资源。
本文翻译者 Oracle 首席技术文档工程师 的播客访谈。
从书虫到技术文档工程师:一段“非典型”旅程
很多人进入技术写作领域是出于偶然,但我似乎在高中时就种下了种子。那时我是一个沉浸在创意写作和文学里的“书虫”,我想靠写作生活,却不想只局限于新闻或教学。
我父亲的一句话点醒了我:“有一种职业叫技术文档工程师。” 经过实习、攻读专业写作学位以及在医疗 IT 行业的磨练,我最终来到了 Oracle。现在,我负责为公用事业部门编写帮助人们节约能源的软件文档。能以写作为生,且这份写作带着“支持绿色能源”的使命感,我几乎不能再奢求更多。
什么是“文档之美”?代码即诗,文档亦然
在很多同行的眼里,“美”这个词在技术文档面前显得有些奢侈。大家会说:“我们是写作者,又不是设计师,文档只要准确、有用就行了,美不美重要吗?”
但我始终认为,文档也存在一种类似“代码即诗”的优雅。
我非常认同 Daniele Procida 的一个观点。他将质量分为两个维度:
- 功能质量(Functional Quality): 准确、完整、一致、精确。这是地基,是必须达到的标准。
- 深度质量(Deep Quality): 使用起来感觉良好,流畅、赏心悦目,甚至能预判用户的下一步需求。
如果没有功能质量,美感就无从谈起;但如果没有深度质量,文档就仅仅是冷冰冰的说明书。 用户不仅仅是理性的机器,他们也是会感应视觉刺激、拥有情感的人类。一份精心排版、导航清晰、图文并茂的文档,能极大地降低用户的认知负荷。
AI 时代,视觉设计还重要吗?
当生成式 AI(GenAI)开始通过聊天框直接给用户答案时,很多人担心:AI 又不“看”布局,我们追求的美感还有意义吗?
我的答案是:更有意义。
- 信源回溯: 大多数 AI 服务都会提供源文档链接。当用户为了确认准确性而点击链接时,他们看到的依然是你设计的页面。
- 不“污染”AI 的源头: 正如同行 Fabrizio Benedetti 所言,为了迎合 LLM 而牺牲人类阅读体验是短视的。高质量的表格、图表和语义化标签,不仅服务于人类,也能让 AI 更好地“理解”内容。
- 包装的价值: 在 AI 时代,内容的“包装”(元数据、替代文本、清晰的结构)变得前所未有的重要。这其实是设计与可访问性(Accessibility)的深度融合。
给同行的几点心得
在播客的最后,我也分享了一些实用的建议:
- 寻找清晰与美感的平衡: 如果你因为忙碌无法重构整个 CSS,那就去雕琢一个清晰的流程、一个易读的段落。专注写作本身,就是在创造美。
- 给 20 岁自己的忠告: 不要过度执着于“内容复用”。虽然复用很强大,但过度工程化会带来巨大的维护开销。保守一点,留出艺术创作和谨慎规划的空间。
- 学习资源推荐: Charles Kostelnick 的《超文本设计》(Hypertext Design):学习如何从全局(空白、页边距、导航)审视文档。
- Miles Kimball 的《文档设计》(Document Design):非常实用的字体排印和版式设计指南。
写在最后
当我听到“文档”这个词,脑海中浮现的第一个词是:“有帮助的”(Helpful)。
我们不仅仅是在堆砌文字,我们是在帮助他人解决问题。而一份具有“深度质量”的美丽文档,正是我们对用户最好的尊重。