术语规范
适用对象:文档编写者与维护者。 本页用于统一写作语义,不是面向最终用户的功能说明。
规范术语
- 系统账号(
User):Memoh 系统内账号。 - 平台账号(
ChannelIdentity):用户在外部接入平台上的账号,不是 Memoh 内账号。 - 接入平台(
channel):承载入站消息的外部平台。 - 账号绑定(
bind):把平台账号关联到系统账号的过程。 - 绑定码(Bind Code):用于账号绑定的一次性代码。
- Bot:由系统账号管理的资源与授权边界。
推荐写法
- 面向产品语义时,优先写 “平台账号”,不要直接写 actor。
- 描述业务行为时,优先写 “接入平台”,不要直接写 channel。
- 首次出现保留技术别名,后续可只用中文术语:
- 平台账号(
ChannelIdentity) - 系统账号(
User) - 账号绑定(
bind)
- 平台账号(
禁用或不推荐写法
- 在概念文档中直接使用 actor(除非明确引用代码符号)。
- 使用含糊表述如 “平台用户”(未区分系统账号与平台账号)。
- 写出“平台账号是 Memoh 内部账号”这类错误语义。
示例
- 正确:“平台账号是用户在飞书上的账号,不是 Memoh 系统账号。”
- 正确:“账号绑定用于把平台账号关联到系统账号。”
- 错误:“Actor 是 Memoh 里的用户。”
自检清单
- 是否明确区分了系统账号与平台账号?
- 叙述中是否将 channel 表述为接入平台?
- 是否仅在首处保留技术别名?
