用途:在新增或编辑 topic-docs YAML 时使用,指导编写与审查符合规范的字段组合、引用和取值复用。
主要能力:提供编写工作流与校验要求。先阅读 topic-docs/README.md 作为主要参考;遇到不清晰或冲突时,以代码校验/构建行为为准,涉及 app/src/data/topicDocs/schema.ts 与 app/scripts/topic-docs-build/attributeResolution.ts。
使用方式:定位 topic-docs/<topic>/<tableName>.yaml 目标表文件;按 README 的字段与组合规则编写;ref 与 valuesRef 的指针需使用 <tableName>.<attributeKey> 且目标必须存在;除非有意使用 format: ignore,否则保留 label/description 便于阅读。在 app/ 目录下验证:bun run topic-docs-build;可选:bun run topic-docs-coverage-check -- --table <tableName>。
必要检查:不得出现无效组合(如 ref 与 values 同时使用、valuesRef 与 values 同时使用等);valuesAdd 仅可与 ref 或 valuesRef 搭配;format: ignore 不定义取值;章节引用须指向真实章节 ID。
输出期望:YAML 保持最小且明确,优先用 ref/valuesRef 复用,而非复制粘贴大量重复枚举。
限制:资料未提供更多平台、收费或效果信息。