dromara / dromara/easy-query

后续可以优化下文档吗

Open
#466 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
777
Forks
78
PR merge metrics
No merged PRs in 30d

Description

很久以前就关注到这个项目了,这两天认真看了下,感觉做的很不错,确实能解决mybatis-plus下的许多痛点,给大佬赞助了杯奶茶钱,希望框架能越来越好。

不过说实话,这个官方文档确实有点劝退,我感觉主要是有这么几个问题:

- 左侧导航栏的结构不太清晰,想找个什么功能经常要把几个标签都点开来看一下。
- 有的标签一眼看不出是什么意思,需要点开正文查看上下文才明白是干嘛的。
- 正文的排版感觉有一点点乱,一方面是太宽了不像其他框架的说明文档那样基本都是居中显示,很容易分散注意力。另一方面是好像写的有点随意,上下文联系不太紧密,注释或者关键说明可能也少了点。
- 再加上说明和代码背景的配色也有点花里胡哨的,我经常感觉读一会儿人就晕了。
- 最后一点就是表述上好像有点偏口语化了,项目源码中的注释也是,而且文档和源码注释也有对不上的情况,后续是不是可以考虑用AI润色优化下?

我觉得平时开发有80%的时间只会用到ORM最简单的几个功能,可能把这种最简单常用的增删改查操作做成入门教程会对新手更友好一些,也有利于开发者评估后续转向该框架的大概代价。

当然,以上只是初次接触后的个人感受,而且不排除是我自己的原因,并不是要对您苛责什么。

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.