技术文档目的
让人看懂
- 目标人群
- 如何让人看懂
目标人群
- 技术小白
- 维护人员
- 专业人员
如何让人看懂
- 把厚的做薄 —— 简洁
- 逻辑清晰
- 尽可能减少阅读时间
工具选择
工欲善其事，必先利其器
文档格式
- reST
- Markdown
- Org-mode
首选 Markdown，其次 reST
技术博客
- Github + Github Page + Jekyll/Sphinx
- Github + Read The Docs + Sphinx
静态博客框架 hexo、Jekyll、Octopress、Hugo、Sphinx 动态一键部署 WordPress
托管服务器
文本格式
- 标题
- 文本
- 段落
- 数值
- 标点符号
体系规范
README 示例
附录
- 《Technical Communication》
- 《Developing Quality Technical Information》
- 中文技术文档写作规范
- reStructuredText
- reST 语法参考
- Markdown 语法参考
