
工具
如何选择文档生成器,而不是选择一种信仰
Sphinx、MkDocs、Astro 等工具针对不同内容模型和团队优化。应比较作者流程、扩展能力、本地化和维护成本,而不是只看演示页面和功能清单。
2 分钟阅读
文档生成器、检查工具、代码仓库、CI 流程及文档基础设施。

Sphinx、MkDocs、Astro 等工具针对不同内容模型和团队优化。应比较作者流程、扩展能力、本地化和维护成本,而不是只看演示页面和功能清单。

围绕“选择文档搜索:从失败查询开始”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“选择文档搜索:从失败查询开始”,重点是可执行、可验证和可维护的做法。

围绕“图表即代码:什么时候有用,什么时候没有”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“图表即代码:什么时候有用,什么时候没有”,重点是可执行、可验证和可维护的做法。


围绕“大规模 Markdown:避免仓库失控的约定”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“大规模 Markdown:避免仓库失控的约定”,重点是可执行、可验证和可维护的做法。

样式 linting 最有价值的地方,是发现术语漂移、风险措辞和可重复的编辑缺陷。规则应少而明确,并保持足够安静,让一次失败真正值得作者注意。 样式 linter 可以在几秒内检查成千上万句子,因此很容易产生“把所有偏好都编码进去”的冲动。