Skip to content

文档标准

本文档要求仓库文档描述当前分支上的实际实现。截至 2026-06-12,当前文档基线为 0.3.0

文档类型与组织

主要文档类型

  1. API 参考文档 (api.md) - 公共接口说明
  2. 教程 (tutorial.md) - 面向使用者的示例和最佳实践
  3. 设计文档 (design.md) - 表示、规范化与实现思路说明

组织原则

  • 按包组织文档,并保持和代码结构一致。
  • 不要文档化当前仓库中尚不存在的 API 或语义。
  • internal 可以文档化,但必须明确它是实现辅助层,不是稳定公开契约。

统一要求

  • precisionroundingclassifysignnormalized 使用一致术语。
  • 明确区分精确表示语义、舍入语义与球包络语义。
  • 示例必须和当前代码一致。
  • 本仓库当前不包含 benchmark 文档。