ドキュメント標準

このリポジトリのドキュメントは、現在のブランチに存在する実装を記述しなければなりません。2026-06-12 時点の文書基準は 0.3.0 です。

ドキュメントの種類と構成

主なドキュメント種類

1. API 参照 (api.md) - 公開インターフェースの説明
2. チュートリアル (tutorial.md) - 利用者向けの例と使い方
3. 設計文書 (design.md) - 表現、正規化、実装方針の説明

構成原則

• パッケージごとに整理し、コード構造と揃えること。
• 現在の実装に存在しない API や振る舞いは文書化しないこと。
• internal は文書化してよいが、安定公開 API ではなく実装補助層であることを明記すること。

共通ルール

• precision、rounding、classify、sign、normalized の用語を統一する。
• 正確表現、丸め、ball enclosure の意味論を混同しない。
• 例は現在のコードと一致させる。
• benchmark 文書はこの基準の対象外。