easy-next-admin/docs

EasyNextAdmin 文档目录

这里保留适合作为开源项目交付的文档。当前文档只描述仓库中真实存在、可运行、可二次开发的能力。

推荐阅读顺序

顺序	文档	适合对象	内容
1	本地开发	新贡献者、二开团队	环境要求、本地依赖、前后端启动、演示账号和常见问题
2	功能与组件	产品、测试、前后端开发	当前内置功能、页面入口、权限码、组件用法和扩展方式
3	架构与实现原理	后端、前端、架构开发	模块分层、请求链路、认证授权、数据权限、审计、工作流和调度原理
4	编译与部署	运维、交付、开发负责人	Maven/NPM 构建、JAR 部署、Nginx 静态部署、Docker 构建和生产配置
5	参考项目与借鉴边界	选型、贡献者、二开团队	说明参考了哪些项目的哪些功能、组件和设计边界

开源协作

文档	适合对象	内容
贡献指南	贡献者、二开团队	本地开发、提交要求、验证命令和 PR 信息
安全策略	使用方、安全研究者	支持范围、安全问题报告方式和生产安全说明
行为准则	所有参与者	讨论、提交、Issue 和 PR 的基本协作边界

技术组件

文档	适合对象	内容
技术组件文档	后端、前端、架构开发	按技术组件说明如何使用、实现原理、tradeoff、常见坑和扩展建议

治理基线

文档	适合对象	内容
可观测性体系蓝图	架构、运维、后端、二开负责人	从开放标准、RFC 和厂商实践沉淀日志、指标、链路、事件、审计和中小企业落地路线
稳定性体系蓝图	架构、运维、后端、二开负责人	从 SRE、RFC 和云厂商可靠性实践沉淀 SLO、韧性模式、发布恢复和中小企业落地路线
企业级组件能力矩阵	架构、后端、运维、二开负责人	梳理企业级应用组件、分布式组件、平台支撑组件、交付分层和研发治理，以及 EasyNextAdmin 已具备和缺少的能力

设计稿

文档	适合对象	内容
Easy Job 设计	后端、架构、运维	从单实例锁到广播批处理的演进、控制面、实例心跳、执行日志和能力边界
Easy Batch 设计	后端、架构、二开团队	多实例动态分区、准备屏障、Claim/Lease、Reader / Processor、断点续跑和一致性取舍
文档结构整理设计稿	维护者、二开负责人	规划业务模块、技术组件和二开流程文档的目录、模板和整理顺序

文档维护规则

• 功能、组件和 README 只写当前代码已经具备或能够通过公开命令启动验证的能力。
• 治理基线可以沉淀标准、厂商实践、路线图和扫描清单，但必须明确这些内容是演进蓝图，不能写成已实现能力。
• 新增页面时，同步补充 API 包装、路由、菜单、权限码、后端权限注解和文档说明。
• 不把规划项写成已完成能力。未实现内容必须放在 issue、roadmap 或单独设计稿中。
• 不保留模板品牌、历史实验前端、内部执行计划和与当前工程无关的中间件清单。
• 默认中文表达，面向中文企业后台二开团队。