技术写作与文档2013authorea.com
Authorea：在浏览器中撰写研究论文
Authorea: Write research papers inside your browser
导读
这是 Authorea 的发布帖：一个在浏览器里写科研论文的在线编辑器，主打 LaTeX 支持与多人协作，目标是“重新发明在线文章”，让图表变成可交互的动态内容。对写作者来说，它触及几个真问题：写作工具如何降低协作成本、学术写作的格式与模板门槛、以及正文之外（图表、批注、评审）如何承载信息。
可以直接用的写作要点
- 01
先想清楚读者已有的工具（LaTeX、Word）为什么不够用，新工具的价值要能一句话说清，否则读者第一反应就是“为什么”。
- 02
写作平台如果能内置目标期刊/会议的模板，就等于替作者省掉最枯燥的格式调整环节，这也是吸引投稿者的关键。
- 03
别把图表当装饰：用 d3.js 之类的可视化让数据“动起来”，可以让论文的核心论点比静态图更有说服力。
- 04
把批注做成不进入正文、导出时自动隐藏的边注，既保持成稿干净，又能在写作阶段承载同行评审与自我提醒。
HN 评论精选
新写作工具必须回答“为什么不用现有工具”，并用期刊模板证明实用价值。
落地页写着“直接在浏览器里写科研论文”。作为研究者，我第一反应是“为什么？”——实验室免费给我的 LaTeX 工具和好用的 MS Word 有什么问题？接着我会问：有哪些我可能投稿的期刊/会议模板？如果你们收录大多数期刊和会议的模板，就能触达远更多的人，我才觉得它能起飞；否则对我来说它只是个带 LaTeX 支持的花哨文本编辑器，还想做成 arXiv 那样，而 arXiv 上已经有很多噪音出版物了。
ank286查看英文原文
Landing page comment: "Write research papers, right inside your browser" As a researcher, I immediately ask "Why?" What is wrong with my Latek utils and fabulous MS Word that my research lab gave me for free. Then, where are some templates for the journals/conferences I could possible use with Authorea. You can reach far more people if you included templates from most journals/conferences. Then I can see this taking off.. Otherwise it is nothing but a fancy text-editor to me with Latek support and is trying to be like arXiv. As it is, arXiv has a lot of noisy publications.
协作写作的痛点是“简单+协作+引用管理”三者兼得，而流畅度是底线。
这类东西确实很缺。我们课题组能找到的最好折中是 Google Docs——简单又能协作，但当然它不支持参考文献。这个产品视觉上很讨喜、功能也不错，不过对我来说它很卡、反应迟钝。
xaa查看英文原文
Something like this is sorely needed. Google Docs is the best compromise between simplicity and collaboration that my group has come up with, but of course it doesn't have reference support. It is very visually appealing and has good features. However, for me, it seems very sluggish and unresponsive.
在线写作的下一步是让图表动态化、可交互，而不只是静态插图。
我们的目标是重新发明在线文章。必须改变的一点是让图表活起来。实现方式有几种，其中之一是用 d3.js 这类 JavaScript 库渲染动态图像。可以看这个例子：https://www.authorea.com/522（目前 Firefox 上还不能用）。
natejenkins查看英文原文
Our goal is to reinvent the article online. One thing that really needs to change is that figures need to come to life. While there are a few ways too accomplish this, one is by using javascript libraries such as d3.js to render dynamic images. As an example of things to come, have a look at: https://www.authorea.com/522 Does not work in Firefox at the moment.
把批注与正文分离，既保持成稿干净，又能支持行内同行评审。
想法很好，实现也很不错。我唯一会怀念 Google Docs 的是“不属于正文的批注”（在 Docs 里显示在文档右侧）。可以用某种特殊语法实现批注：导出和正式页面不渲染，编辑模式下只显示一个小图标；再加一个“点这里加批注”的图形界面会更方便。这还能带来更多能力，比如轻松实现行内同行评审。
krcz查看英文原文
That's a great idea and really good implementation. The only thing I'd miss from Google Docs are comments that are not part of a text (in Docs these are rendered on right side of document). You could implement it by come special syntax for comments, which wouldn't render when exported and on site, and in edit mode, it would show just a little icon. GUI option to click somewhere to add comment in this place would make it even easier. It allows further capabilities, like easy inline peer review.
同类还值得读
编写更好文档的框架
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 条写作要点编辑精选