起步
请选择适合您当前角色的阅读路径。每条路径均从平台模型出发,逐步深入至相应的技术实现。
如需查看针对特定受众的详细路径,请参阅 用户画像。了解已开放安装的组件及其获取方式,请参阅 安装与可用性。
首次接触 Nimi
建议按照以下顺序阅读:
- 平台:了解产品模型、以“世界”为核心的基础概念,以及跨域的六项基础协议。
- Runtime:了解 AI 任务的实际调度与执行机制。
- SDK:掌握应用接入 Nimi 平台的标准化边界与集成规范。
- 桌面端:了解第一方原生外壳(Shell);网页端的差异请参阅 Web 模式。
- Realm:理解语义真相、世界状态以及不可篡改的世界历史。
该路径旨在帮助构建全局的心智模型,随后深入实现细节,厘清平台架构、AI 执行流程及应用交互方式。若遇生僻术语,可查阅跨章节通用的术语表。
评估项目架构
如果您正在评估本项目架构与核心价值,建议按照以下顺序阅读:
- 平台愿景:项目核心目标与产品定位。
- 平台架构:明确各组件权责边界的跨层架构图。
- Runtime 概览 与 Runtime 工作流:底层 AI 执行引擎的核心职责。
- SDK 概览 与 SDK 边界:外部应用接入平台时需遵守的规范与边界。
- Nimi Coding 白皮书:本项目中 AI 辅助工程的治理范式。
上述内容的阅读量大致相当于一篇技术文章,能清晰呈现 Nimi 当前架构的全貌。
基于平台进行构建
应用开发者请直接从 SDK 与 Runtime 章节起步。SDK 是应用与平台交互的官方途径。应用代码不应跨越 Runtime 与 Realm 的私有边界。
了解原生外壳的具体行为,请查阅 桌面端。关于网页端的受限呈现模式,请研读 Web 模式。网页端不会自动继承桌面端的原生扩展能力。
采用 Nimi Coding 方法论
Nimi Coding 作为独立于宿主环境的方法论,已作为标准 npm 软件包发布。建议按照以下顺序了解:
- Nimi Coding 概览:核心范式及软件包的整体构成。
- 议题工作流:涵盖 Topic、Wave、Packet、Preflight、Audit 至 Closeout 的生命周期。
- 安装指南:软件包的安装步骤与采纳路径。
场景:应用开发者的阅读路径
假设您是一名新接触 Nimi 的应用开发者,推荐的首次阅读路径如下:
- 阅读 平台,确立“世界”而非“会话”是平台核心运转对象的基础认知。
- 阅读 Runtime,理解 Provider 调度、工作流、流式传输及多模态产物等逻辑均由 Runtime 契约统筹,而非应用代码。
- 阅读 SDK,掌握如何通过
sdk/runtime、sdk/world、sdk/realm、sdk/ai-provider、sdk/scope及sdk/mod合规消费底层能力,避免直接导入私有模块。 - 阅读 桌面端 与 Web 模式,明晰两种呈现形态的能力边界差异,以评估其对应用分发计划的影响。
- 准备进行代码贡献时,阅读 Nimi Coding。处理高风险变更或跨模块重构时,需遵循此标准工作流。
全景阅读完成后,如需查阅具体的技术细节,可借助 规范地图 定位到底层技术契约。