🥰 需求描述
文档混乱,例如:
- 现在的 README 过于繁杂
- 文档自身以及与 docs/DEPLOY.md 等文档多有重复
- 存在文档脱离 docs 目录(例如 API.md)
- 部分文档过长,可删除一些内容
🧐 解决方案
文档优化建议:
README.md 写必要的项目介绍,不做过多说明,部署运行另用部署文档,同样功能配置、本地运行等介绍另用文档。
好的文档不仅能让AI更直接了解项目,也能让自己、让用户都明白使用方法。另外,逆向项目不建议文档写得过于详细(尤其 README.md),清除一部分玩家还能保证项目稳定一些。
📝 补充信息
此功能需求非必要优化,可用于提升用户使用体验。
🥰 需求描述
文档混乱,例如:
🧐 解决方案
文档优化建议:
README.md 写必要的项目介绍,不做过多说明,部署运行另用部署文档,同样功能配置、本地运行等介绍另用文档。
好的文档不仅能让AI更直接了解项目,也能让自己、让用户都明白使用方法。另外,逆向项目不建议文档写得过于详细(尤其 README.md),清除一部分玩家还能保证项目稳定一些。
📝 补充信息
此功能需求非必要优化,可用于提升用户使用体验。