技术文档写作指南
latest
前言
文档组织逻辑
文档写作四法则
段落的组织逻辑
句子写作方法
混合排版规则
固定排版规则
Sphinx 快速使用
文档结构
reStructuredText 标记
reStructuredText 指令
Sphinx 扩展指令
交叉引用
Sphinx 配置
Read the Docs 文档托管
参考文献
技术文档写作指南
»
技术文档写作指南
在 GitHub 上修改
技术文档写作指南
前言
技术文档是什么
技术文档的写作流程
文档组织逻辑
阐述逻辑
基于读者考虑
文档组织逻辑模板
文档写作四法则
主题明确单一
语言简洁明了
图表优于文字
例子增强理解
段落的组织逻辑
分类与归纳组合
精简语句
标题
句子写作方法
避免使用长句
语义明确
其它
混合排版规则
标点符号
数值
英语专有名词
空格
固定排版规则
快捷键
依次选择菜单栏上的选项
上下文的链接
图片说明
Sphinx 快速使用
安装
创建文档
编辑文档
构建文档
优化文档
文档结构
文件命名
图片命名
reStructuredText 标记
章节标题
段落
行块
引用块
代码块
表格
列表
字段列表
选项列表
定义列表
链接
行内标记
脚注引用
分隔符
注释
转义符
reStructuredText 指令
图片
替换引用
更强大的表格
标记主题
输出原始内容
Sphinx 扩展指令
目录
另类标题
代码块语法高亮
交叉引用
交叉引用文件
交叉引用任意位置
引用可下载文件
Sphinx 配置
项目信息
一般配置项
HTML 输出选项
epub输出的选项
配置文件示例
配置实例
Read the Docs 文档托管
创建 GitHub 项目
Read the Docs
参考文献
网页
书籍
Read the Docs
v: latest
版本列表
latest
下载链接
pdf
html
epub
托管于 Read the Docs
项目首页
构建