文档编写

我们使用 Gitbook 进行文档编写,请下载 Gitbook Editor 以便可视化操作。(也可使用 Atom,按 ctrl + shift + m 打开预览窗口 )

建议开启 目录双栏编辑 模式,以便学习 markdown 语法,更好把控文档。

插入本地图片很方便,但请注意命名,让目录更洁净一些。

为了加速网络访问,我们把文档源码托管于 Coding,并使用了 Webhook 同步到 Pages。也就是说,任何文档修改都会触发编译器,编译成 html 发布于线上。所以,大家可以直接到代码库修改源码,也可以使用 Gitbook Editor 编辑,点击 SAVESync 进行同步。

注意:使用 Gitbook Editor 之前,请先安装 Git 工具,并执行 git clone 命令把代码克隆到本地:

git clone https://git.coding.net/paishi/company-open.git

文档编写规范

参考《中文技术文档的写作规范》

results matching ""

    No results matching ""