1 工具
1.1 准备开发工具
描述开发 Smart 应用所需要的开发工具及其安装步骤，包括：IDE、JDK、Maven、Git 等。 有必要时可使用截图，但不要大量使用。 需突出开发工具的版本号，以免误导用户使用不兼容的软件。 |
1.2 搭建开发环境
描述搭建开发环境的操作步骤及其注意事项。 对于操作步骤可使用截图与文字进行描述。 分别针对 Eclipse 与 IDEA 进行说明。 |
2 入门
用一个 Hello World 示例让读者学会如何使用 Smart 开发应用。 前端使用认识度较高的 JSP 技术进行展现，使用 jQuery 与 Bootstrap，可参考 项目。 不要大量使用的 Smart 功能特性，目标仅在于让读者可以跟着步骤自行搭建 Smart 应用开发框架。 |
3 架构
3.1 技术选型
使用表格的方式展现 Smart 框架使用到的开源项目。 简要说明每项选型的选择原因。 |
3.2 项目依赖
通过一张图来展现 Smart 框架所使用的程序包之间的依赖关系。 通过一张表格来展现依赖程序包的详细情况，包括：文件大小、版本号、最后更新日期等。 在表格下方需给出依赖程序包的总文件大小。 |
3.3 系统架构
给出一张系统架构图，列举出最重要特性，以及框架与插件之间的关系。 使用“类图”描绘框架的静态结构。 使用“时序图”描绘一个请求的生命周期。 通过一张图来展现插件的生命周期，并简要描述插件的开发过程。 |
4 特性
通过代码片段与文字描述的方式，分别对框架的每种特性进行说明。 可使用 中相关代码。 可在代码片段中增加必要性的代码注释。 可在文字描述中引用外部链接，如：博客地址、相关参考文档等。 |
4.1 MVC
4.2 IOC
4.3 AOP
4.4 ORM
4.5 DAO
4.6 事务控制
4.7 异常处理
4.8 单元测试
5 插件
代码片段加文字描述的方式，分别对每个插件的基本用法进行说明。 可使用 中相关代码。 需对插件所使用的开源技术进行说明。 可引用相关参考资料，如：博客地址、开源项目官网等。 |
5.1 Cache
5.2 WebService
5.3 Mail
5.4 I18N
5.5 Job
5.6 Hessian
6 附录
6.1 常用 API
对日常开发过程中用户使用较为频繁的 API 进行描述。 使用表格的方式对 API 进行汇总。 使用 Cookbook 的方式展示 API 的使用方法。 |
6.1.1 Result
6.1.2 Page
6.1.3 DataSet
6.1.4 DataContext
6.2 代码生成器
描述 Smart 代码生成器的安装与使用方法。 |