API表面より契約を先に

ドキュメント

Samchilのドキュメントは、API詳細の前に、検証根拠、モジュール契約、既知の制限、購入とアクセスの境界を理解できる構成にします。

01 / Planned

はじめに

Samchilの評価、badgeの読み方、limitationの確認、moduleがprojectに合うか判断する方法を説明します。

  • Samchil promiseとexclusions
  • Module pageの読み方
  • Verification Reportの場所
  • Contactとsupport path
状態
Planned
対象
技術購入者と初回モジュール利用者
境界
Badgeがbuyer自身のproduction validationを置き換えるとは主張しません。

02 / Draft source exists

Samchil Verification Standard

Verified、Trusted、Provenの段階と各段階に必要なevidenceを文書化します。

  • Evidence philosophy
  • Badge level requirements
  • Downgradeとreview expectations
  • 明示的なnon-guarantees
状態
Draft source exists
対象
購入者、maintainer、reviewer
境界
SVSはlegal、regulatory、compliance、security certificationではありません。

03 / Planned

モジュール契約

Package contents、version expectations、supported runtime scope、access後に提供される内容を説明します。

  • Package contents
  • Runtimeとcompatibility notes
  • Known limitations
  • Update policy references
状態
Planned
対象
有料モジュールを統合する開発者
境界
Module contractはcustom integration、universal compatibility、production fitnessを約束しません。

04 / Partially implemented

Verification Reports

Report field、evidence status、compatibility row、limitation、badge approvalの記録方法を説明します。

  • Quality、security、documentation、compatibility section
  • Evidence references
  • Known critical issue handling
  • Badge approval caveats
状態
Partially implemented
対象
購入前にevidenceを比較するtechnical evaluator
境界
Reportはレビューされたscopeだけを説明し、すべてのenvironmentやfuture versionを証明しません。

05 / EnvおよびAPI Error Handler checkout wired

購入とアクセス

Purchase path、GitHub Private Repository access model、manual recovery expectations、open implementation gapを文書化します。

  • Polar hosted checkout
  • Polar-connected GitHub benefitによるrepository access
  • Env Config ValidatorおよびAPI Error Handler checkout path
  • Manual support path
  • Website-owned order/webhook gaps
状態
EnvおよびAPI Error Handler checkout wired
対象
Polar checkoutとGitHub repository accessを利用する購入者
境界
Website-owned license records、webhooks、refund automationが実装前に存在すると示唆しません。

06 / Draft policy source exists

ライセンス、返金、サポート

Allowed use、prohibited redistribution、refund eligibility、support scopeを購入前に見えるようにします。

  • Commercial license summary
  • Refund window and eligibility
  • Support email and scope
  • Warranty and certification exclusions
状態
Draft policy source exists
対象
商用利用とサポート境界を確認する購入者
境界
Refundとlegal policy wordingはfinal publication前にowner/legal reviewが必要です。

07 / Planned per module

統合ガイド

レビュー済みpackage evidenceに基づき、module-specific installation、configuration、examples、framework notesを提供します。

  • Install and import steps
  • Minimal examples
  • 実装済みの場合のみframework-specific notes
  • Documented behaviorに基づくtroubleshooting
状態
Planned per module
対象
Applicationにmoduleを追加する開発者
境界
Moduleに存在しないframework exampleのguideは公開しません。

08 / Planned

変更とマイグレーション

Module releaseのchangelog、update policy、compatibility changes、migration notesを追跡します。

  • Release tags
  • Compatibility changes
  • Breaking change notes
  • Verification report updates
状態
Planned
対象
Updateを検討する既存購入者
境界
承認済みpackage policyを超えるlong-term maintenanceやSLA commitmentは約束しません。

公開ルール

公開ドキュメントは、実装済み機能、検証済み根拠、ownerが確認したlaunch boundaryと一致している必要があります。

  • 新しいbadge claim、pricing claim、support promise、refund language、product availability statementの公開前にはowner reviewが必要です。