本地使用 GitBook 以及多人协作书写本手册

安装 gitbook-cli

$ npm install gitbook-cli -g

windows安装参考文档：https://www.cnblogs.com/Lam7/p/6109872.html

fork 并克隆本项目

$ git clone https://github.com/${YOUR_NAME}/datafoundry-document

安装 gitbook 插件

$ cd datafoundry-document
$ gitbook install

启动 gitbook server

$ gitbook serve

gitbook 默认启动端口为4000。通过浏览器查看本手册 http://localhost:4000。

文件内容发生变化时，页面会自动刷新。

Pull Request

提交至自己的仓库，并向datafoundry-document发起一个 Pull Request。

书写规范

本手册将由多人协作完成，为保持文档风格统一和水准，请遵循一定的书写规范。

文档书写规范参考中文技术文档的写作规范以及文案风格指南。

更多参考链接

• 产品手册中文写作规范, by 华为
• 写作规范和格式规范, by DaoCloud
• 技术写作技巧在日汉翻译中的应用, by 刘方
• 简体中文规范指南, by lengoo
• 文档风格指南, by LeanCloud
• 豌豆荚文案风格指南, by 豌豆荚
• 中文文案排版指北, by sparanoid
• 中文排版需求, by W3C
• 为什么文件名要小写？, by 阮一峰
• Google Developer Documentation Style Guide, by Google