多语言文档站的荒野西部
来源:technicalwriting.dev — 2026-10-12
📋 概述
一个提供多种语言 SDK 的项目,其文档站往往要拼装 N 到 N+1 个 API 参考生成器的输出,因为每种语言都有自己的生成器;而站点又要求字体配色统一、站内搜索一致且全面,耦合反而更紧。作者把这类站点称为 polyglot docs site,并直言目前没有成熟做法。文章给出两条自上而下的策略,第一条是转换:解析各生成器的输出,转成主文档生成器友好的标记——作者的第一份工作就用 XSLT 把 Doxygen HTML 转成简单片段。
🔑 核心要点
- polyglot docs site 指整合多语言 API 参考输出的站点
- 每种语言各有一套 API 参考生成器
- 难点在字体配色与站内搜索一致性
- 策略一:转换各生成器输出再拼装
- 作者曾用 XSLT 处理 Doxygen HTML 输出
💡 金句
polyglot docs sites feel like a sparsely explored frontier of technical writing, full of rattlesnakes and tumbleweeds.
👍 0
👎 0
← 返回 Hacker News 首页