文档编写

 
一.在学习开发文档该如何编写前的几个问题 
为什么要写开发文档？开发文档都要写什么内容？开发文档该如何写？就是 为什么写，写什么，怎么写。 
1.关于为什么写 
(1).扩展一个人的记忆 (2).团队共享相同的信息 (3).减少人员流动的损失 (4).书写过程中发现问题 (5).方便今后的工作查找 
2.关于写什么 
(1).文档主要内容 (2).整体功能 (3).开发平台，运行环境，开发语言 (4).相关代码 (5).操作流程 (6).根据不同文档的类型文档的内容各有不同。 
3.关于怎么写 
(1).避免口语化，要体现技术要点 (2).形式简约，每种事务的相关文档要有一致的风格 (3).书写角度，是针对专业人士还是用户，文档的书写的难易程度 (4).解决问题，文档能切合实际的解决问题。 (5).写好的文档整理，归档和共享。 (6).日积月累。 
二.文档的一些类型： 
可行性分析报告，项目开发计划，说明书，测试计划，开发总结，产品文档 等  
三.文档编写工具 
Word excel Markdown Xmind 思维导图流程图 截图工具 Ps 
 
四.学习 markdown 文档编写语法 
1.一些快捷键 
加粗 Ctrl + B 斜体 Ctrl + I 引用 Ctrl + Q 插入链接 Ctrl + L 插入代码 Ctrl + K 插入图片 Ctrl + G 提升标题 Ctrl + H 有序列表 Ctrl + O 无序列表 Ctrl + U 横线 Ctrl + R 撤销 Ctrl + Z 重做 Ctrl + Y 
2.基本语法： 
1. 标题设置（让字体变大，和 word 的标题意思一样） 在 Markdown 当中设置标题，有两种方式： 第一种：通过在文字下方添加“=”和“-”，他们分别表示一级标题 和二级标题。 第二种：在文字开头加上 “#”，通过“#”数量表示几级标题。（一 共只有 1~6 级标题，1 级标题字体最大） 
 
2. 块注释（blockquote） 通过在文字开头添加“>”表示块注释。（当>和文字之间添加五个 blank 时，块注释的文字会有变化。） 
 
3. 斜体 将需要设置为斜体的文字两端使用 1 个“*”或者“_”夹起来 
 
4. 粗体 将需要设置为斜体的文字两端使用 2 个“*”或者“_”夹起来 
 
5. 无序列表 在文字开头添加(*, +, and -)实现无序列表。但是要注意在(*, +, and -)和文字之间需要添加空格。（建议：一个文档中只是用一种无序列 表的表示方式） 
 
6. 有序列表 使用数字后面跟上句号。（还要有空格） 
 
7. 链接（Links） 
Markdown 中有两种方式，实现链接，分别为内联方式和引用方式。 内联方式：This is an [example link](http://example.com/). 引用方式： I get 10 times more traffic from [Google][1] than from [Yahoo][2] or [MSN][3].   
 
[1]: http://google.com/        "Google"  [2]: http://search.yahoo.com/  "Yahoo Search"  [3]: http://search.msn.com/    "MSN Search"  8. 图片（Images） 图片的处理方式和链接的处理方式，非常的类似。 内联方式： 引用方式： ![alt text][id]  
 
[id]: /path/to/img.jpg "Title" 
 
9. 代码（HTML 中所谓的 Code） 实现方式有两种： 第一种：简单文字出现一个代码框。使用`<blockquote>`。（ `不是单 引号而是左上角的 ESC 下面~中的`） 第二种：大片文字需要实现代码框。使用 Tab 和四个空格。 
 
10. 脚注（footnote） 实现方式如下： hello[^hello] [^hello]: hi 
 
11. 下划线 在空白行下方添加三条“-”横线。