跳到正文

实验与预览功能

说明实验状态、启用和退出方式、已知边界以及转为稳定后的文档更新。

让读者在启用前判断

首次出现时写明“实验功能”或项目实际使用的状态名。交代从哪个版本可用、是否默认启用、需要哪些开关。限制应能由读者辨认,例如“仅支持本地搜索索引”“不处理跨语言词组”。需要修改现有项目状态时,写明对应影响和验证方法。

需要回答的问题示例说明
怎样启用在 search 中设置 experimentalRanking: true 后重新构建
怎样知道已启用构建日志显示 ranking: experimental
适用哪些输入适用于标题索引。正文索引仍使用稳定排序
怎样退出移除配置并重新生成索引

隔离环境和数据影响

写清是否适合共享或生产环境。功能产生新格式的文件时,说明旧版本是否能读取,停用时需要保留、重建或移除哪些数据。示例用独立输出路径,给出能够验证退出后的行为。

按实际发布状态更新文档

从实验转为稳定时,检查配置名称、默认值和适用版本。仍可使用的旧开关使用弃用条目说明替代写法。功能暂缓或移除时,更新参考、教学示例和导航中的入口,并注明受影响范围。

用版本记录描述状态变化,并在功能页给出启用、停用和验证的完整路径。