目录
一、 编写文档
1 什么是文档
文档是软件开发使用和维护中的必备资料。
2 文档的作用
文档能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导、帮助、解惑的作用,在维护工作中,文档是不可或缺的资料。
3 文档的类型
文档的类型包括软件需求文档,设计文档,测试文档,用户手册等。其中的需求文档,设计文档和测试文档一般是在软件开发过程中由开发者编写,而用户手册等非过程类文档是由专门的非技术类写作人员编写的。
4 方法
正确的思想和方法很重要,正确的方法能让人事半功倍
-
软件的使用等,首先要学会如何使用才能出更好的文档,让人一目了然,如:格式的好看,语言的连贯使用,让读者有看下去的兴趣
-
不同文档或软件需要不同的操作完成,如解释性文档,教程,手册等
-
文档在于条理清楚,在不同情况下需要言简意赅或者图文并茂,文档使用标题和段落,文本加粗等
-
事例,需要一到两个举例来实现对文档的解释和让用户去操作去理解,从抽象到具体步骤,具体化,解释一些常见问题
-
提供最低解释,对事例或文本进行简单而又适度的解释;减少不必要的话语,提高可读性
-
适当的定期维护文档,如软件更新,内容变化的都需要检查,确保可行性
二、软件介绍
-
Typora 是一种轻量级标记语言,它允许人们使用易读易写的文本格式编写文档
-
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档
-
Markdown 编写的文档后缀为 .md, .txt等
三、软件下载
官网下载地址:Typora — a markdown editor, markdown reader.https://typora.io
四、使用教程
1 文件操作
1.1 文件常用快捷键
快捷键 | 作用 |
---|---|
Ctrl+N | 新建窗口打开新文件 |
Ctrl+shift+N | 新建窗口 |
Ctrl+O | 打开文件 |
Ctrl+P | 快速查找打开文件 |
Ctrl+S | 保存 |
Ctrl+F | 查找文件 |
Ctrl+W | 退出软件 |
Ctrl+H | 查找内容替换 |
-
使用快捷键
-
左上方点击文件选择操作
1.2 软件常用快捷键
1.3 插入目录
使用标题分章节后,输入[toc]生成目录
[toc]
1.4 导入
选择文件 --> 打开或打开文件夹,可以选择导入的文件或者文件夹
1.5 导出
选择文件 --> 导出,可以选择导出的文件格式
2 文本编辑
1.1 基础用法
转移字符
\ 转移字符,设置符号原本的含义
斜体文本
一对星号*或下划线_括住文本表示
快捷键Ctrl+I
*钱钱钱*
粗体文本
用一对**或一对__括住文本表示粗体文本
快捷键Ctrl+B
**粗体文本**
删除线
用一对~~括住的文本来表示删除文本
快捷键Alt+Shift+5
~~要加删除线的文本~~
下划线
用HTML的标签和表示增加下划线的文本<u>1</u>
快捷键Ctrl+U
<u>要增加下划线的文本</u>
1.2 扩展用法
数学公式和HTML(不细究)
文本高亮
选择文件-->偏好设置-->markdown设置
一对==将要高亮的文本括起来,设置后一定要重新启动软件
==111==
上下标
选择文件-->偏好设置-->markdown选择
一对~将下标括起来
H~2~O
一对^将上标括起来
X^2^
插入表情
使用:emoji:的语法来插入表情,
:happy
快速移动
Ctrl+HOME 移动到文件开头
Ctrl+END 移动到文件末尾
3 段落
1.1 标题
#表示标题,1-6最多六级标题,#空格字符加内容回车
# 一阶标题或者快捷键Ctrl+1
## 二阶标题或者快捷键Ctrl+2
### 三阶标题或者快捷键Ctrl+3
#### 四阶标题或者快捷键Ctrl+4
##### 五阶标题或者快捷键Ctrl+5
###### 六阶标题或者快捷键Ctrl+6
提升标题级别Ctrl+=
降低标题级别Ctrl+-
# 1 ## 2 ### 3 #### 4 ##### 5 ###### 6
1.2 表格
快捷键
表格
Ctrl+T 插入表格
表格操作:
Alt+↑ 上移该行
Alt+→ 右移该行
Alt↓ 下移该行
Alt+← 左移该行
Ctrl+shift+退格 删除行
文本插入表格
|标题|标题|标题| |---|---|---| |单元格|单元格|单元格|
字符对齐
:- 表示左对齐 -: 表示右对齐 :-: 表示中间对齐
右键表格选择操作
例:3列4行
去 | 我 | 额 |
---|---|---|
1.3 区块(引用)
Ctrl+shift+Q 或 >+空格
其实世上本没有路,走的人多了,也便成了路。
1.4 代码块
Ctrl+shift+K 或 三个```
点击方框,右下角输入所需语言,shell,python,flow(流程图)等。
#ls -al
1.5 公式块
Ctrl+shift+M
$$
x=2y
$$
1.5 列表
有序列表
Ctrl+shift+[ 有序列表 或 数字加上.再加上空格来表示有序列表
-
q
-
w
-
e
无序列表
Ctrl+shift+] 无序列表或短横线+空格+内容(*,+,- 表示无序列表项,要在标记符号后添加一个空格)
嵌套列表
使用*、+或-进入列表,然后回车换行
按下Tab键,列表第二项变为第一项的子列表,按回车退出当前列表(可在无序列表中嵌套有序列表)
任务列表
短横线+空格+左中括号空格右中括号+空格+内容
- [ ] 1
- 看电视
列表缩进
Ctrl+] 增加列表缩进
Ctrl+[ 减少列表缩进
1.6 文本引用
文本内容+[^1]
云计算天下第一[^1]
1.7 脚注
[1] 数字
1.8 分割线
三个短横线---或者三个星号***
--- ***
1.8 链接引用
[链接文字](链接地址)
[111] www.baidu.com
<链接地址>
<www.baidu.com>
Ctrl+鼠标左键访问
扩展:
链接可以打开相应的网页外和打开本地文件(可使用本地文件的地址,相对地址、绝对地址)
一个小圆点.表示当前目录
两个小圆点..表示上一级目录
1.9 图片
Ctrl+shift+i
感叹号!+中括号[属性文本]+小括号(图片地址,本地图片网络图片均可)
![]()
如:
![image-20210920205318443](C:\Users\z\Data\\Typora\typora-user-images\image-2021.png)
4 视图和主题
快捷键
-
源码模式编辑切换:ctrl + /
-
打字机模式切换:F9
-
专注模式切换:F8
-
全屏模式切换:F11
-
Typora内部窗口焦点切换:ctrl+tab
-
侧边栏显示/隐藏切换:ctrl+shift+L
软件左上方选择,根据需求选择所需