好的文档有三个作用，一是帮助自己整理思绪，二是提高别人的可读性与协作效率，三是个人门面，提高个人影响力。就像衣服一样，要舒适，也要好看。 <!-- more --> ## 目录 - [一、写作格式](https://liugongzi.org/#%E4%B8%80%E3%80%81%E5%86%99%E4%BD%9C%E6%A0%BC%E5%BC%8F) - [二、关于图片](https://liugongzi.org/#%E4%BA%8C%E3%80%81%E5%85%B3%E4%BA%8E%E5%9B%BE%E7%89%87) - [三、Markdown 的最佳实践](https://liugongzi.org/#%E4%B8%89%E3%80%81Markdown%20%E7%9A%84%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5) - [3.1 题目](https://liugongzi.org/#3.1%20%E9%A2%98%E7%9B%AE) - [3.2 各级标题](https://liugongzi.org/#3.2%20%E5%90%84%E7%BA%A7%E6%A0%87%E9%A2%98) - [3.3 中英文](https://liugongzi.org/#3.3%20%E4%B8%AD%E8%8B%B1%E6%96%87) - [参考资料](https://liugongzi.org/#%E5%8F%82%E8%80%83%E8%B5%84%E6%96%99) ## 一、写作格式 除非必要，只用 Markdown，因为它像 Http 协议一样，四海通用，迁移性强。 ## 二、关于图片 推荐阿里云 OSS，支持通过 url 后缀修改大小，可以实现本地 Markdown 与 Confluence 的无缝迁移 ## 三、Markdown 的最佳实践 ### 3.1 题目 1. 一级标题留给题目，或者不写 2. 题目与正文之间需要有一段简介 ### 3.2 各级标题 1. 标题要简短，结尾不带标点符号 2. 不用四级及其以下标题，内容中只用二三级标题，二级对应汉字一二三，三级对应 1.1，1.2，之后的用 1，2，3 即可 3. 同级标题不能只有一个 4. 标题前后空一行（段前距和段后距） ### 3.3 中英文 - 中文与英文，中文与数字之间隔一个空格 ## 参考资料 [老何的 1001 夜之：高级wiki编辑技巧 - 搜索技术组 - Qunar.com engineer wiki](https://wiki.corp.qunar.com/pages/viewpage.action?pageId=18154117) [https://tingtalk.me/markdown/](https://tingtalk.me/markdown/) [https://tingtalk.me/style-guide/](https://tingtalk.me/style-guide/)