面向开发者的阶跃ai智能办公技术文档需用方框图明确模块职责、单向箭头标注精确数据类型、部署域写实名；接口说明绑定curl样本/grpc proto路径/websocket精简消息结构；状态机仅画5个主干状态，条件为可编程布尔表达式。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
面向开发者的阶跃AI智能办公技术文档，必须让工程师一眼看懂系统边界、数据流向与接口契约，不能靠堆砌术语掩盖设计模糊。
明确划定模块职责边界
第一步：用方框图列出所有核心服务组件，每个方框只写一个动词+名词的短语，例如“解析用户指令”“调用审批API”“生成会议纪要”。【禁止在方框内写‘负责处理’‘支持多种场景’这类空泛描述】
第二步：在相邻两个方框之间画单向箭头，箭头旁标注传输内容的精确类型，如“JSON格式的待办ID列表”“base64编码的截图二进制流”。如果箭头双向存在，必须拆成两条独立箭头，分别标注入参和出参。
第三步：对每个方框右下角用小号字体标出所属部署域（如“前端Web Worker”“私有云GPU节点”“第三方SaaS网关”），不写“云端”“本地”这种模糊词。
接口说明必须绑定真实请求样本
方法一：在HTTP接口描述下方直接贴curl命令，包含完整Header（含Authorization示例值）、-d参数的JSON体（字段值用具体业务数据，如"meeting_id": "mtg_20241105_8a3f"），不加注释行。
方法二：gRPC接口写明proto文件路径（如/proto/v2/summary_service.proto），并在下方列出该service中实际被调用的三个method名称，删掉未被智能办公流程引用的冗余method。
方法三：WebSocket事件说明采用表格形式，列名依次为“触发时机”“发送方”“消息结构（精简版）”，其中“消息结构”只保留必填字段及典型嵌套层级，例如{"type":"action_complete","payload":{"task_id":"TK-789","result":"success"}}。
状态机图只画主干流转路径
① 从“用户提交语音指令”开始，到“生成最终文档并推送至钉钉”结束，中间只保留五个关键状态节点。
② 每个状态节点旁标注该状态下系统持有的唯一标识符（如session_id、doc_draft_id），不标注时间戳或日志级别。
③ 所有分支条件必须是可编程判断的布尔表达式，例如“ASR置信度≥0.85 && 无歧义实体”，禁用“用户意图明确”“上下文足够”等主观描述。
这一步操作起来很简单，直接把Mermaid代码块粘贴进文档渲染器就行，但要注意删除自动生成的默认注释行——它们会干扰开发者快速定位状态跳转逻辑。
