核心概念
本页解释了在使用 Archyl 时会遇到的关键概念。
项目
项目 是架构文档的顶层容器。每个项目代表您要记录的一个软件系统或产品。
项目包含：
- 架构图（系统、容器、组件、代码）
- 元素之间的关系
- 文档和 ADR
- 用户流程
- 设置和团队访问权限
元素
元素是架构图的构建块：
系统
系统 代表一个软件系统——最高级别的抽象。在 C4 模型中，这是您正在记录的内容。
- 内部系统：您拥有和维护的系统
- 外部系统：您与之交互的第三方系统（API、SaaS 产品）
容器
容器 是一个可独立部署/运行的单元，用于执行代码或存储数据：
- Web 应用程序
- 移动应用
- API 服务器
- 数据库
- 消息队列
- 文件系统
组件
组件 是容器内相关功能的分组：
- 控制器
- 服务
- 仓储
- 模块
代码元素
代码 代表最低层级——实际的代码构造：
- 类
- 接口
- 函数
- 模块
关系
关系 展示元素之间的通信或依赖方式。它们包括：
- 描述交互的 标签（例如"读取自"、"发送事件到"）
- 可选的 技术 信息（例如"REST/HTTPS"、"gRPC"、"AMQP"）
- 显示流向的 方向
叠加层
叠加层 是帮助组织图表的视觉分组，不会改变底层结构。用途包括：
- 分组相关元素
- 突出显示特定区域
- 创建视觉边界
层级
Archyl 使用 C4 模型的四个抽象层级：
| 层级 | 展示内容 | 目标受众 |
|---|---|---|
| 系统上下文 | 系统在其环境中的位置 | 所有人 |
| 容器 | 高层技术构建块 | 技术人员 |
| 组件 | 容器内的组件结构 | 开发者 |
| 代码 | 代码级别的细节 | 开发者 |
组织与团队
组织
组织 是您帐户的工作空间。它包含：
- 所有项目
- 团队成员
- 计费信息
- 设置
团队
团队 帮助组织对项目的访问权限：
- 按部门、项目或职责分组团队成员
- 控制对特定项目的访问
- 在团队级别管理权限
角色
Archyl 有三种角色：
| 角色 | 可查看 | 可编辑 | 可管理 |
|---|---|---|---|
| 查看者 | 是 | 否 | 否 |
| 编辑者 | 是 | 是 | 否 |
| 管理员 | 是 | 是 | 是 |
AI 发现
AI 发现 是自动分析代码库以发现架构元素的过程。它：
- 连接到您的 Git 仓库
- 分析代码结构和模式
- 识别系统、容器和组件
- 创建元素之间的关系
- 生成文档建议
ADR
架构决策记录 (ADR) 记录重要的架构决策：
- 决定了什么
- 为什么做出这个决定
- 考虑了哪些替代方案
- 后果是什么
流程
用户流程 记录用户或数据如何在系统中流转：
- 逐步序列
- 与架构元素的链接
- 可视化流程图