技术写作与文档2017mirror.unicorncloud.org编辑精选
用 LaTeX 撰写科学文档（2009）
Writing Scientific Documents Using LaTeX (2009) [pdf]
导读
这篇 2009 年的 LaTeX 科学文档入门 PDF 在 HN 上引发了关于写作与排版工具的讨论：LaTeX 适合公式和复杂排版，但长期维护可能很脆弱；评论者比较了云服务、Markdown/Pandoc、Word+InDesign 等不同工作流。对写作者来说，值得读的地方在于：工具会直接影响写作摩擦、维护成本和内容呈现方式，选工具时应服务于持续写作，而不是让排版调试反客为主。
可以直接用的写作要点
- 01
优先选择能长期维护的写作工具，避免几年后文档无法编译、修复调试挤占写作时间。
- 02
入门 LaTeX 可先用 Overleaf 等云服务和入门教程，降低安装与环境配置的门槛，先写起来。
- 03
笔记和普通文稿可用 Markdown 配合 Pandoc 保留人类可读性，同时输出带公式和排版的 PDF。
- 04
让工具服务内容：排版细节和工具调试不应吞掉真正用于构思与修改的时间。
HN 评论精选
LaTeX 长期维护脆弱，Word+InDesign 工作流更快。
我曾是 LaTeX 科学文档的拥护者，甚至用 LuaLaTeX 写过植物志；能调用 Lua 正确格式化学名很棒。现在少用有两个原因：一是脆弱，2010 年写的文档用最新 TeXLive 已无法构建，修复调试很耗时，而植物名录需定期更新，被故障打断很沮丧；二是先用 Word 写、必要时导入 InDesign 排版更快更简单，也更适配我常用的引用软件 Papers。
whyenot查看英文原文
I used to be a big proponent of using LaTeX for scientific documents. I even wrote a botanical flora using LuaLaTeX. Being able to drop down into Lua was wonderful for formatting scientific names correctly (something that may seem simple, but is not). I don't use it as much anymore for two reasons. 1. It's fragile. Documents I wrote in 2010 no long "build" with the latest TeXLive release, and fixing and debugging my documents has been a huge time sink. With something like a flora or plant list, that needs to be updated periodically with new information, getting sidetracked by breakage can be very frustrating. 2. I've found it's a lot quicker and simpler for me to write in MS Word and then (if needed) import into Adobe InDesign to style my writing. This combination also seems to work better with the citation software I prefer (Papers).
用 LaTeX 展示排版效率，可降低学生对代码和写作工具的畏惧。
LaTeX 是许多学生接触代码的好入口。很多学生怕编程、宁愿做实验；有人用 Matlab 或 LabVIEW 做统计或控制设备却很痛苦，面对遗留的面条代码或难搞的设备感到受威胁，不愿花时间理解。给他们看一个基础 LaTeX 文档，说明写论文尤其是学位论文能比 Word 的噩梦轻松，常会带来顿悟。
knolan查看英文原文
LaTeX is a wonderful gateway for many students to expand their exposure to code. A lot of students will shy away from coding prefering more hands on work in the lab. Some students will use Matlab or LabVIEW to perform some essential task and hate every minute of it. It might be some stastical analysis they don't understand built with spaghetti code they've inherited, or it might be for controlling a contrary piece of lab equipment. Either way they feel threatened by it or don't want to spend the time learning to understand it. Show them a basic LaTeX document and how it can make writing papers and, importantly their thesis, much easier than the horror show that is Word and suddenly there is a moment of wonder.
Markdown+Pandoc 兼顾可读性与排版输出，适合笔记和文稿。
我喜欢 LaTeX，但也很享受用 Pandoc 的 Markdown 作为替代，并支持公式。LaTeX 里很麻烦的表格在 Markdown 中很简单，文本和布局用 Markdown，数学与排版用 LaTeX 命令。我开始用它写很多笔记，因为 TeXMacs 最近不好用；人类可读的文本还能编译成漂亮的 PDF，体验很好。
LolWolf查看英文原文
I love LaTeX, but I've been really enjoying Markdown in Pandocs as an alternative (with equation support, of course). All of the problems with tables (which are really some of the worst things in LaTeX) are super simple and everything can be written in Markdown format for text/layout along with the usual LaTeX math commands and typesetting. I've begun using it to write a lot of my notes, since TeXMacs has sadly been failing lately, and to be honest it's wonderful having human-readable text along with a document that compiles nicely to a PDF with all the bells and whistles.
云服务和学习资源能降低 LaTeX 入门门槛。
刚入门 LaTeX 不必安装任何东西，可用 Overleaf 或 ShareLaTeX 等云服务（ShareLaTeX 最近加入了我们团队）。ShareLaTeX 有实用的 LaTeX 学习 wiki，我在 Overleaf 的联合创始人还做了三部分入门课程。希望对入门者有帮助，用过这些服务也欢迎反馈。
JohnHammersley查看英文原文
If you're just getting started with LaTeX, you can do so without needing to install anything by using a cloud-based service such as Overleaf [1] or ShareLaTeX [2] (who've recently joined our team [3]). ShareLaTeX also provide a very useful LaTeX learn wiki [4], and my co-founder at Overleaf created this three part introductory course [5]. Hope this helps anyone getting started, and feedback on Overleaf/ShareLaTeX is always appreciated if you've used it previously. [1] https://www.overleaf.com [2] https://www.sharelatex.com [3] https://www.overleaf.com/blog/518-exciting-news-sharelatex-is-joining-overleaf [4] https://www.sharelatex.com/learn [5] https://www.overleaf.com/latex/learn/free-online-introduction-to-latex-part-1
同类还值得读
编写更好文档的框架
A Framework for Writing Better Documentation
这是 Divio 的文档写作框架，把技术文档按「读者的目标」分成四类：教程（学习导向）、操作指南（问题导向）、参考（信息导向）、解释（理解导向）。
技术写作与文档2021 · 637 分 · 76 评4 条写作要点编辑精选写好一份设计文档
Writing a good design document
这篇 HN 帖子标题为《Writing a good design document》，主题是如何写好一份设计文档；对写作者来说，它值得作为技术写作和结构化说明文的参照。
技术写作与文档2025 · 581 分 · 147 评3 条写作要点编辑精选技术写作课程
Technical Writing Courses
这是 Google 官方免费技术写作课程（两门），讲受众定义、主动语态、短句、文档结构等基础方法。
技术写作与文档2020 · 571 分 · 73 评4 条写作要点编辑精选写出更好的错误信息
Write better error messages
这篇帖子讨论如何写出更好的错误信息，评论补充了开发者场景下的具体做法和真实反面案例。
技术写作与文档2022 · 566 分 · 253 评4 条写作要点编辑精选写一本技术书的经济账
The Economics of Writing a Technical Book
一位技术书作者拆解写书的真实经济账：版税收入往往远低于投入的时间成本。
技术写作与文档2018 · 519 分 · 149 评4 条写作要点编辑精选