37 lines
1.3 KiB
Markdown
37 lines
1.3 KiB
Markdown
# 文档编写说明
|
|
|
|
本项目文档站用于说明 **Deep Engine 是一个基于 Three.js WebGPU 的封装库**，因此文档内容应尽量围绕库本身的能力、接口和示例展开，而不是保留 VitePress 默认示例内容。
|
|
|
|
## 文档编写原则
|
|
|
|
- 所有文档内容优先使用中文
|
|
- 文档说明应和 `packages/sdk/src` 的实际实现保持一致
|
|
- 文档示例应优先参考 `packages/demo/src` 中的真实调用方式
|
|
- 当 SDK 接口发生变更时，应同步更新对应文档
|
|
|
|
## 推荐文档结构
|
|
|
|
建议文档内容按以下方式组织：
|
|
|
|
- 首页：说明项目定位、技术基础与核心能力
|
|
- API 文档：说明类、函数、参数、返回值和属性作用
|
|
- 示例说明：展示典型场景的接入方式与调用片段
|
|
|
|
## 当前项目说明
|
|
|
|
Deep Engine 的核心特点包括：
|
|
|
|
- 基于 Three.js WebGPU 封装
|
|
- 提供统一的 Viewer 视图管理能力
|
|
- 提供参数化建模、特效、剖切、点云和体积处理能力
|
|
- 支持结合 Demo 快速理解 API 的实际使用方式
|
|
|
|
## 后续维护建议
|
|
|
|
如果后续继续补充文档，建议优先完善以下内容：
|
|
|
|
- 关键类的完整使用流程
|
|
- 常见业务场景的接入步骤
|
|
- 参数化对象、体积效果、点云效果的组合示例
|
|
- 与 `packages/demo/src` 对应的专题示例页
|