docs: complete documentation polish — CHANGELOG v3.1-v3.5, README update, plan cleanup, v3.6 ideas
CI / Build & Test (push) Failing after 1m32s
CI / Release Build (push) Failing after 31s
Build & Test / build-and-test (push) Has been cancelled
Build & Test / python-bindings (push) Has been cancelled

This commit is contained in:
茂之钳
2026-07-24 14:13:26 +00:00
parent d9a673257e
commit 2c59c55c6b
9 changed files with 140 additions and 41 deletions
+48 -35
View File
@@ -1,40 +1,53 @@
# ViewDesignEngine 工程文档
# ViewDesignEngine 文档目录
## 文档索引
> 版本 3.5.0 | 最后更新 2026-07-24
| 编号 | 文档 | 说明 |
## 开发计划
| 文档 | 版本 | 状态 |
|------|------|------|
| **第一阶段:需求分析** | | |
| 01 | [市场调研与竞品分析](01-需求分析/01-市场调研与竞品分析.md) | 7 个引擎对标 |
| 02 | [需求规格说明书](01-需求分析/02-需求规格说明书.md) | 16 类功能需求(含差异化功能) |
| 03 | [用例文档](01-需求分析/03-用例文档.md) | 6 个核心用例 |
| 04 | [功能差距分析](01-需求分析/04-功能差距分析.md) | 41 项差距,5 级优先级 |
| 05 | [核心竞争力与差异化功能](01-需求分析/05-核心竞争力与差异化功能.md) | 14 项独有/首创功能 |
| **第二阶段:概要设计** | | |
| 06 | [系统架构设计](02-概要设计/01-系统架构设计.md) | 7 层模块架构 |
| 07 | [模块划分](02-概要设计/02-模块划分.md) | 7 个模块详细清单 |
| 08 | [接口定义](02-概要设计/03-接口定义.md) | 接口 + C API |
| **第三阶段:详细设计** | | |
| 09 | [数据结构设计](03-详细设计/01-数据结构设计.md) | 半边网格/NURBS/BVH |
| 10 | [核心算法设计](03-详细设计/02-核心算法设计.md) | 算法伪代码 |
| 11 | [类设计](03-详细设计/03-类设计.md) | 工厂/策略/访问者模式 |
| **第四阶段:编码实现** | | |
| 12 | [编码规范](04-编码实现/01-编码规范.md) | C++17 规范 |
| 13 | [目录结构](04-编码实现/02-目录结构.md) | 工程目录树 |
| **第五阶段:测试验证** | | |
| 14 | [测试计划](05-测试验证/01-测试计划.md) | CI + 性能基准 |
| 15 | [测试用例](05-测试验证/02-测试用例.md) | 8 组测试用例 |
| **第六阶段:部署维护** | | |
| 16 | [构建指南](06-部署维护/01-构建指南.md) | 三平台构建 |
| 17 | [API 参考](06-部署维护/02-API参考.md) | 全部 API 签名 |
| [v3.0 开发计划](00-开发计划.md) | v0.1 → v3.0 | ✅ 完成 |
| [v3.1 开发计划](10-v3.1-开发计划.md) | v3.1 | ✅ 完成 |
| [v3.2 开发计划](11-v3.2-开发计划.md) | v3.2 | ✅ 完成 |
| [v3.3 开发计划](12-v3.3-开发计划.md) | v3.3 | ✅ 完成 |
| [v3.4 开发计划](13-v3.4-开发计划.md) | v3.4 | ✅ 完成 |
| [v3.5 开发计划](14-v3.5-开发计划.md) | v3.5 | ✅ 完成 |
## 杀手功能(竞品无人支持)
## API 参考
| 功能 | 阶段 | 说明 |
|------|------|------|
| 2D 草图约束求解器 | v2.0 | 开源唯一,商业 CAD 核心资产 |
| SDF 隐式建模 | v1.5 | 程序化建模/有机形态 |
| 可微分几何 | v2.0 | AI+CAD 交叉领域 |
| 惰性求值几何管线 | v1.0 | TensorFlow 式的几何计算图 |
| Python 原生绑定 | v0.5 | pip install 即用 |
| 二进制序列化 | v0.5 | 比 OBJ/STL 快 10x |
| 文档 | 说明 |
|------|------|
| [API-REFERENCE.md](API-REFERENCE.md) | Markdown API 参考手册(6942 行) |
| [Gitea Wiki](http://git.hdtime.space:3000/hm/ViewDesignEngine/wiki) | 在线 Wiki(12 页,含首页介绍) |
| `docs/api/html/index.html` | Doxygen HTML 文档(483 页,本地生成) |
## 教程
| 文档 | 说明 |
|------|------|
| [01-快速开始](tutorial/01-quickstart.md) | 5 分钟上手 |
| [02-SDF 建模](tutorial/02-sdf-modeling.md) | SDF 隐式建模教程 |
| [03-B-Rep 建模](tutorial/03-brep-modeling.md) | B-Rep 工业建模教程 |
## 部署与构建
| 文档 | 说明 |
|------|------|
| [构建指南](06-部署维护/01-构建指南.md) | CMake 构建说明 |
| [API 参考](06-部署维护/02-API参考.md) | 旧版 API 文档 |
| [packaging/](../packaging/build-deb.sh) | DEB 打包脚本 |
| [Doxyfile](../Doxyfile) | Doxygen 配置文件 |
## 其他
| 文档 | 说明 |
|------|------|
| [benchmark-report.md](benchmark-report.md) | 性能基准报告 |
| [gen_api_ref_v2.py](gen_api_ref_v2.py) | API 参考生成脚本 |
| [mainpage.h](mainpage.h) | Doxygen 主页源码 |
## 外部链接
- [Gitea 仓库](http://git.hdtime.space:3000/hm/ViewDesignEngine)
- [Gitea Wiki](http://git.hdtime.space:3000/hm/ViewDesignEngine/wiki)
- [CHANGELOG](../CHANGELOG.md)