Merge pull request #4 from qiuyiuestc/yqiu

更新文档模板，按照文档功能进行拆分。

docs/api.md

@@ -1,9 +1,12 @@
-
 # Hello API
 
-## `int hello_func(void)`
+## 打招呼
+
+> 注意：对于函数介绍，必须遵循下面的格式
+
+`int hello_func(void)`
 
-hello_func 函数
+hello_func 的函数描述
 
 | 参数              | 描述                                |
 |:------------------|:------------------------------------|
@@ -12,9 +15,9 @@ hello_func 函数
 |0                  | 正确执行                            |
 |-1                 | 失败                                |
 
-### 例子
+示例(可选)
 
-``` c
+``` {.c}
 #include <hello.h>
 
 int func()

docs/introduction.md

@@ -1,47 +1,31 @@
-# hello 介绍 #
+# hello 介绍
 
 > 说明：你需要在这里对 hello 软件进行简单的介绍，描述背景、功能特点等等……
 
-## 版本和修订
+## 软件架构
 
-| Date       | Version   |  Author    | Note  |
-| --------   | :-----:   | :----      | :---- |
-| 2018-04-28 | v0.1      | Armink     | 初始版本 |
-| 2018-05-28 | v1.0      | Armink     | 同步更新 |
-|            |           |            | |
+> 简单介绍
 
-## 文件目录结构
-
-```
-hello
-├───src                    //源代码
-├───inc                    //头文件
-├───examples               //应用示例
-├───docs                   //介绍文档
-    |───introduction.md    //软件介绍
-    |───user-guide.md      //使用说明
-    |───api.md             //API 说明
-    |───samples.md         //示例程序说明
-```
-
-## 软件架构 ###
-
-### 软件架构图 ###
+### 软件架构图
 
 ![hello 软件架构图](./figures/framework.png)
 
-如上 hello 软件架构图所示, 共分为 x 层，……。
+如上 hello 软件架构图所示, 共分为 x 层，……，每一层描述。
+
+## hello 功能特点
 
-## hello 功能特点 ##
+### 功能一
 
-### 功能一 ###
+hello 的功能一。
 
-功能一说明
+- 功能
+- 功能
+- 功能
 
-### 功能二 ###
+### 功能二
 
-功能二说明
+功能二
 
-### 功能三 ###
+### 功能三
 
-功能三说明
+功能三

docs/port.md

@@ -0,0 +1,3 @@
+# 移植说明
+
+> 在不同的硬件平台上使用，需要做的移植工作说明。

docs/principle.md

@@ -0,0 +1,3 @@
+# hello 工作原理
+
+> 介绍 hello 的工作原理

docs/samples.md

@@ -1,8 +1,6 @@
 # hello 示例程序 #
 
-## 示例介绍 ##
-
-这是 hello 的示例。
+> 示例程序的简短说明。
 
 ## 运行示例 ##
 

docs/user-guide.md

@@ -1,13 +1,21 @@
-# hello 使用说明 #
+# hello 使用说明
 
-## 如何使用 ##
+> 简短说明
 
-应该怎么样使用 hello
+## 准备工作（可选）
 
-## 如何配置 ##
+## 背景信息（可选）
 
-应该怎么样配置 hello
+## 步骤一（可选）
 
-## 注意事项 ##
+## 步骤二（可选）
 
-使用 hello 时有什么注意事项
+## 步骤三（可选）
+
+## 预期结果（可选）
+
+## 示例（可选）
+
+## 完成后的操作（可选）
+
+## 引用链接（可选）

docs/version.md

@@ -0,0 +1,7 @@
+# 版本和修订 #
+
+| Date       | Version   |  Author    | Note  |
+| --------   | :-----:   | :----      | :---- |
+| 2018-04-28 | v0.1      | Armink     | 初始版本 |
+| 2018-05-28 | v1.0      | Armink     | 同步更新 |
+|            |           |            | |