Ingot

产品用语

Ingot 面向生产、工艺、质量、设备和现场 IT 人员。页面、接口说明和对外文档必须使用工厂日常工作中的说法,不能把程序内部概念直接翻译给用户。

写作原则

  • 按用户正在做的工作命名,例如“查询生产周期”“比较参数”“上传检测附件”。
  • 按现场对象命名数据,例如“设备参数”“检测结果”“生产记录”“工艺阶段”。
  • 区分机器采集、人工录入和系统估算,页面使用“记录方式”或更具体的业务名称。
  • 分析能力逐级表达:先说明数据是否完整,再描述变化、参数关系、可能原因和工艺建议。
  • 数据不足时直接说明缺少的设备参数、检测结果、批次信息或周期记录。
  • 只分析与工艺和质量直接相关的核心参数,不为了分析方便引入现场没有的班次、组织或人员表现信息。

统一用词

  • 已保存的现场数据:生产记录、生产履历。
  • 分析结果对应的数据:相关生产记录、原始记录链接。
  • 检测时上传的照片或文件:检测附件、现场照片。
  • 登录和提交身份:用户、检测员、工位。
  • 产品中的不同操作区域:功能入口、使用方式。
  • 完整表格、曲线或下载内容:明细结果、下载文件。
  • 数据如何产生:记录方式、阶段来源、计算方式。
  • 尚未确认的异常原因:可能原因。
  • 与当前判断不一致的数据:相反情况、复核结果。

公开 JSON 字段也遵守同一规则,例如检测附件使用 attachments,分析结果中的相关记录使用 relatedRecords,登录身份使用 userId

检查问题

提交前确认:现场人员是否不看接口文档也能理解标签;同一个词是否始终表示同一件事;页面是否说明数据来自机器、人员还是系统计算;分析结果是否清楚说明能做什么、还缺什么。

在 GitHub 查看源文件