Dictionary

A dictionary tool helping people to search information quickly and accurately.

ChangeLog

Version.2019.09.19 文档初始化，明确项目背景、需求。 Version.2019.09.29 文档修改，对需求中的数据库设计进行修改，在词条表中增加词条类别配合需求。

数据字典工具

Version.2019.09.29 | kevin

一、背景分析

在别人开发的项目上进行开发时，往往会面临一些源码解读的问题，如果项目的注释编写的有组织有结构，语言描述通俗易懂，可读性高，那么嵌入开发的难度就会小很多。但，大部分情况下，由于源头不友好的对象命名，导致，后续开发者即使在明白自己要添加什么逻辑的时候，因为不友好的变量名，导致开发的效率大幅降低，所以开发者们迫切需要一个不受环境约束的数据字典，该字典可以手动维护，大大减少对于字段、表、变量名复查的时间。

二、可行性分析

可行性分析将从技术可行性、经济可行性、操作可行性进行分析。
技术可行性：本项目考虑到不受环境限制的因素，计划设计为Web项目，使用Java语言开发，IDEA作为IDE，SpringBoot框架管理业务过程、MyBatis框架实现后台开发、前端使用jQuery框架实现请求封装、HTML页面展示UI，Thymeleaf引擎解析数据，MySQL数据库存储数据，GoogleCloud部署项目。这些软件或技术在市面都是开源成熟的技术，因此该项目在技术上完全可行。
经济可行性：本项目属于方便个人的项目，不存在经济利益关系，因此该项目在经济上完全可行。
操作可行性：本项目考虑到用户的身份为软件开发工作者，所以简单的UI，统一的接口，对于用户而言是是操作可行的。

三、需求分析

3.1 面向用户

该项目面向一类特殊用户，即后续开发者，在前开发者开发的项目上进行开发的人。

3.2 场景描述

用户在嵌入开发时，遇到不理解的字符串（字符串可以代表任何类），可以使用该工具进行搜索查询，输入要查询的字符串后，如果该词条已存在，点击确认可以查询出对应的词条释义。如果不存在， 则给出响应的提示。用户也可以对已存在的词条进行编辑，编辑的痕迹将被记录，编辑的过程不支持回滚。用户还可以对不存在的词条进行新建编辑，新建的词条将可以被其他用户公开查阅。

3.3 数据库设计

  用户表（唯一编号、用户名、密码、权限标志、创建时间）
  词条表（唯一编号、词条类别、词条名称、词条类别、词条释义、父词条编号、创建时间、最后修改时间）
  记录表（唯一编号、用户编号、词条编号、生成时间）

3.4 数据字典

 用户表（唯一编号：唯一确定一个用户对象。
                 用户名  ：用户在工具中的唯一身份标识。
                  密码    ：用户验证身份的代码。
               权限标志：用户在工具中可以进行的行为标识。
               创建时间：用户初次注册时间。）
  词条表（唯一编号：唯一确定一个词条
               词条类别：词条所属类型。
               词条名称：词条的字符构成。
               词条类别：词条的所属类别。
               词条释义：词条的具体含义或转义。
            父词条编号：词条的上级词条编号。
               创建时间：词条创建的时间。
            最后修改时间：词条最后被编辑的时间。）
  记录表（唯一编号：唯一确定一条记录。
                用户编号：该记录由唯一确定的用户产生。
                词条编号：该记录由唯一确定的词条所对应。
                生成时间：该记录生成的时间。）