如何高效技术写作?

介绍进行科技写作的基本原则、方法、工具等
作者

Lin Xuhong

发布日期

2021年12月31日

前言

在我日常工作中,需要大量进行科技文章写作,也需要大量阅读他人的技术文章;同时为了工作的方便,写了大量的笔记,有记录代码内容、配置方法或是算法细节。如此多的写作与阅读量,除了需要靠提高阅读速度和书写速度,更重要的是,需要有一套完善的工具与方法,来迅速地输出内容,让自己专注于内容。

在快速阅读的同时,记录了大量的笔记,在写代码做实验的时候,也记录了大量的数据与想法。随时长时间的累积,这些笔记越来越臃肿,也越来越零散,之前看似分类效果良好的文件夹、标签、笔记本,也越来越不好查找想要的内容。更重要的是,笔记条目里,藏着大量零时的想法,却一直没有删除归档,时间越久,越搞不清楚其中的价值。

经过长久的摸索,我发现最好的办法,莫过于把这些笔记整理,并按主题写成书的形式。这一形式最方便管理、查找、更新,也最容易记录数据、引文的出处,方便以后追溯。

于是,问题就变成了:如何高效进行技术书籍写作?如何让写技术书籍的速度与便捷程度,等同于写笔记本身?

本书就来探讨高效写作技术书籍的方方面面。

版本记录

2021年12月31日:完成第一版

TODO

2022年版本TODO: 1. 补充 LaTeX 调度技巧一节内容。 2. 补充如何写论文,补充到第一章,可参看 How to write a great research paper,作者Simon Peyton Jones 3. 增加数学技术写作一章; 4. 部分内容修订。 5. 书籍尺寸,以及书籍的基本知识与概念,书本一般分为哪几个部分,前言、序言、跋代表的含义及规则 6. 参考文献的管理,Zotero,卡片式整理方法 7. LaTeX 使用与调试技巧:那些使用 LaTeX 需要注意到的排版问题。