文档全貌
| 板块 | 内容 | 使用方式 |
|---|---|---|
| 开始 | 整体概念、开发第一个应用、Studio 协作、学习路径 | 第一次接触 NocoBase 3 时阅读 |
| Core 手册 | 开发应用、使用插件、开发插件、框架原理、部署维护、参考 | 按正在开发或维护的功能查阅 |
| Studio 手册 | 安装配置、成员接入、任务开发、项目管理、Agent 管理、质量管理、发布管理、系统管理、参考 | 按角色与当前操作查阅 |
| 完整项目教程 | 准备环境与选择 Agent、用 Core 开发应用、通过 Studio 协作、最佳实践与附录 | 希望跟随一个项目逐步实践时阅读 |
| FAQ | NocoBase 2 与 3 的区别、功能对应与迁移 | 需要了解版本关系时查阅 |
完成首次上手
先读 NocoBase 3 是什么,理解应用底座、开发治理与业务应用的关系。
- 自己创建应用:按开发第一个应用创建、启动并开发客户管理,检查角色权限后再继续迭代。
- 已加入 Studio 团队:直接按使用 Studio 协作开发完成一个需求;管理员尚未准备环境时,先进入安装与配置。
两篇上手文章各自给出所需前提,无需先读完所有手册。
深入开发与扩展应用
应用能运行后,从应用开发概览了解功能的组成,结合项目结构定位文件。开发应用手册覆盖页面与交互、服务与接口、数据与权限、后台任务、命令行以及测试。
需要认证、文件、通知等通用能力时,查使用插件;功能要独立维护或跨应用复用时,进入开发插件。理解运行时、服务容器、HTTP、数据库等底层机制时,再查框架原理。
使用与管理 Studio
- 成员日常工作:从提出需求和会话开始,按需查跟进进展、回答提问和验收。
- 项目负责人:查项目设置、知识库、项目记忆和项目进展,再了解检查与评审及发布。
- 管理员:完成安装配置,再按需管理Agent、运行环境、技能、用量、成员与角色及升级备份。
状态、权限、Agent 执行规则、命令和配置项集中在 Studio 的参考部分。
跟随完整项目教程
构建可靠业务系统以资产管理应用为线索,按顺序完成环境准备、设计、设备管理、申请审批、角色权限、验收和部署,再进入 Studio 的团队协作、知识积累与发布。
这条路线适合希望持续练习完整项目的人。已完成快速上手,可根据已有基础选择继续阅读的位置;遇到具体机制,返回对应手册查阅。