Merge pull request #3 from qiuyiuestc/yqiu

Add templates for building user-manual.

docs/api.md

@@ -1,23 +1,18 @@
-# Hello
 
-Hello 是RT-Thread上的一个演示用package。
+# Hello API
 
-## API
+## `int hello_func(void)`
 
-### `int hello_func(void)`
-
-hello 函数
+hello_func 函数
 
 | 参数              | 描述                                |
 |:------------------|:------------------------------------|
 |`无`               | 无参数                              |
-
-| 返回值            | 描述                                |
-|:------------------|:------------------------------------|
+| 返回              | — —                                |
 |0                  | 正确执行                            |
 |-1                 | 失败                                |
 
-#### 例子
+### 例子
 
 ``` c
 #include <hello.h>

docs/introduction.md

@@ -0,0 +1,47 @@
+# 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 功能特点 ##
+
+### 功能一 ###
+
+功能一说明
+
+### 功能二 ###
+
+功能二说明
+
+### 功能三 ###
+
+功能三说明

docs/samples.md

@@ -0,0 +1,13 @@
+# hello 示例程序 #
+
+## 示例介绍 ##
+
+这是 hello 的示例。
+
+## 运行示例 ##
+
+示例应该怎么运行。
+
+## 示例结果 ##
+
+这是示例的结果。

docs/user-guide.md

@@ -0,0 +1,13 @@
+# hello 使用说明 #
+
+## 如何使用 ##
+
+应该怎么样使用 hello
+
+## 如何配置 ##
+
+应该怎么样配置 hello
+
+## 注意事项 ##
+
+使用 hello 时有什么注意事项