内容组织
文档“收录哪些文件”和“侧栏怎样展示”是两个不同问题。模板明确提供两种模型,避免教程型手册把第三方 README 一并发布,也避免 SDK 示例集合被迫塞进连续章节。
模型 |
适用场景 |
发现范围 |
导航方式 |
|---|---|---|---|
recursive_tree |
教程、产品手册、知识库 |
递归同步允许的文档和资源 |
保留目录树 |
project_catalog |
SDK、BSP、示例工程集合 |
只收录分类匹配项目的入口 README 和声明资源 |
按业务分类 |
两种模型都会将最终文件清单交给 DocumentCatalog。HTML、PDF、语言判断和资源校验共享这份清单,因此不会出现网页只显示项目首页、PDF 却递归收录第三方文档的差异。
在 模型选型 中用真实场景作出选择。