基于Sphinx的技术文档开发教程¶
本书将介绍一种轻量级的文档解决方案,所用工具均为成熟的开源技术。阅读本书后,读者可以用本书的方法,轻松为公司的产品或服务提供所需的帮助文档。
适合读者:
软件文档项目团队
小型写作团队
本书用于《技术传播方法》课程的教学,因为服务于技术写作课程的教学,本书将采用当前流行的 Doc like Code 的模式进行写作。
所用的工具如下:
内容写作。采用轻量级的标记语言:reStructuredText
文档发布工具。Sphinx
协同与版本控制。github
文档托管。Read the Docs
本课程选课同学将按照技术写作的流程,参与到教程的写作和审校工作中。