Nexus 文档页面模板

模板是必须回答的问题清单。标题可以按任务调整；已有规范通过包含或链接复用。 新增/修改正文遵守 内容与图示标准，不得仅有页面 元数据就记录内容合格。实际教程代码来自已验证fixture或固定版本外部示例。

1. Tutorial

  1. 目标和预期完成结果。

  2. 适用代码/SDK版本、Board/OS/模式、工具、工作目录和设备前提。

  3. 输入、配置、所需资源；完整输入与片段分别标明。

  4. 一条完整操作路径，每步给命令或API、预期结果和检查方法。

  5. 遇到常见拒绝/失败时如何定位和保持资源。

  6. 停机、排空、清理，以及结果/存储何时可以复用。

  7. 实际验证记录和下一步。

异步教程连接提交/取消/排空时序图；外部SDK教程连接消费流程图。没有设备时只 说明软件验证和HIL准备，不把未执行硬件步骤写成教程成功结果。

2. How-to

  1. 要完成的单一任务和适用范围。

  2. 合法Task/IRQ/权限上下文、输入和资源所有者。

  3. 最短完整步骤；默认选择与例外明确。

  4. 正常结果、拒绝、超时/取消及失败恢复。

  5. 结束后哪些资源已归还，哪些责任仍保留。

  6. 限制和对应权威合同。

可以省略基础原理并链接解释页，不能省略影响正确性的生命周期或并发条件。

3. Reference

项目

必需内容

字段/符号

精确名称、类型和权威源

数值

单位、范围、默认值及生效条件

组合

有效/无效模式、平台和ABI组合

调用

上下文、deadline、输入/输出所有权

失败

拒绝条件、状态变化、效果与后续责任

资格

当前维护/软件/实板范围和证据入口

API声明自动生成，手册不手抄第二份函数签名。引用完整配置或有原因的fragment。 controller/endpoint、资源和内存布局复杂时连接结构图或精确参考配置图。

4. Explanation

  1. 具体问题和约束。

  2. 当前或目标结构，图的身份与来源。

  3. 各层责任、状态和资源所有者。

  4. 构建阶段与运行阶段，以及依赖/调用/数据流的区别。

  5. 主要流程和失败责任；并发流程连接时序/状态图。

  6. 性能/空间成本、取舍和适用条件。

  7. 当前限制与实际验证范围。

  8. 关联合同、源码和操作指南。

架构解释必须有对应框图；单一简单事实可以引用已有图。无需重复画一张仅改变 颜色或名称的同义图。代码实现与目标提案不能在同一无标记图中合并。

5. Status

  1. 被描述代码、本文档和qualified source分别是什么。

  2. 精确配置、scope、工具与实际执行结果。

  3. 可取得的证据、档案/member与校验方法。

  4. 已实现、已执行、未执行、失败或阻塞项。

  5. 支持和资格边界；下一退出条件。

表中的数字不能跨scope累加；implemented不替代软件/实板通过。资格流程图中 软件证据和HIL分别取得后汇合，不画成软件自动推进到物理通过。

6. 每页审查清单

  • 读者、目标、版本和适用范围明确。

  • 步骤或规则可执行/可判断，命令前提与预期结果齐全。

  • 对象、单位、上下文、借用、失败和恢复明确。

  • 当前/目标/参考、实现/软件/HIL身份没有混淆。

  • 图中实体与每条边均可解释并与源码/合同一致。

  • 代码和配置例子有实际验证或明确片段原因。

  • 正文、图和翻译没有复制出竞争规范。

  • 引用、离线资源、alt/caption和旧URL处理正确。

  • 发现和修正记录绑定实际页面/图与来源。