一整体原理:先找对资料,再回答
把系统想象成一位熟悉资料目录的助理:知道资料属于哪个产品,先翻到相关原文,再把结果讲清楚。
准备产品资料
发布经确认的手册、参数资料、勘误和应用说明,明确适用范围。
整理成可查知识
按章节、步骤和表格等组织内容,记录资料归属与原文位置。
理解用户问题
识别问题中的型号、版本与术语;信息不足时提示补充。
查找相关证据
在适用范围内查找相关章节;既关注准确名称,也理解不同说法。
回答并提供出处
根据找到的证据组织回答,提供可打开的来源,供用户核对。
二一个问题怎样得到回答?
以下为示意流程,不代表某具体芯片的实际参数。
① 用户提问
“型号 A 的某个寄存器如何配置?”
如果型号或手册版本不明确,系统应说明无法确认,并提示用户补充型号或版本。
② 系统找资料
限定型号 A 与所选版本,查找寄存器名称、相关章节和配置说明,再整理可核对的原文片段。
③ 用户核对
获得基于资料的配置说明,并打开对应手册章节核实。若证据不足,系统说明无法确认。
三术语和关系:辅助查找,不替代原文
术语提示
把经过审核的不同叫法关联起来,帮助系统理解用户的问题。例如:同一个外设的完整名称与常用简称。
作用:减少因叫法不同而找不到资料的情况。
关系辅助 (可选)
对确有业务需要的关系进行整理,例如“型号与外设的适用关系”“勘误与芯片版本的对应关系”。
使用条件:关系须有来源、适用范围和版本;需要经过实际问题测试,证明有收益后再启用。
四 文档更新后,如何维护? 目标流程 · 部分能力改善方向
目标是让文档工程师关注资料是否正确,让系统负责检查、整理和提示。说明:下图为目标流程——其中「系统检查」「通过后整体切换」「保留上一可用版本」等能力正在改善方向;当前版本的实际维护操作以管理员手册为准。
正常更新
- 文档工程师发布资料确认型号、版本、文档清单和来源链接。
- 发起同步系统检查资料并在独立区域整理新版本。
- 系统检查核对新增、修改、删除及知识与资料版本是否一致。
- 通过后切换新版本整体生效,用户查询新资料。
发现问题时
- 停止切换资料不完整、检查未通过或同步失败时,不使用不完整的新版本。
- 保留上一可用版本显示失败原因,支持排查和必要时回退。
- 修正后重新同步文档工程师或管理员处理问题后,再次检查。
- 反馈持续改进用户反馈错误或缺口,文档团队核对原文、更新资料并再次同步。
五各方分别做什么?
文档工程师
维护并发布可信资料;确认型号、版本与出处;处理用户反馈中发现的文档问题。
系统管理员
负责同步、检查状态、处理异常和备份恢复;按授权管理系统。
使用者 / 专家
提出问题、核对原文并反馈;涉及关键参数和决策时,由专业人员作最终判断。