技术写作:原理与实践(2020)

本书用于《技术文档写作》课程的教学,因为服务于技术写作课程的教学,本书将采用当前流行的 Doc like Code 的模式进行写作。

所用的工具如下:

  1. 内容写作。采用轻量级的标记语言:reStructuredText
  2. 文档发布工具。Sphinx
  3. 协同与版本控制。github
  4. 文档托管。Read the Docs
  5. 写作工具。MS Visual Studio Code

本课程选课同学将按照技术写作的流程,参与到教程的写作和审校工作中。

注解

目前图书只是列出了大纲,内容正在写作中。请持续关注。

第六章:常用技术写作工具

第七章:技术信息产品评价