Skip to content

Status: implemented

Implemented — this change has shipped.

RFC 0048: Standalone UW document kit and package examples ​

Status and intent ​

This is a scoped adoption RFC, not a proposal for a new financial model or format primitive. The current protocol already permits standalone profiles, .uwpart.md fragments, all-in-one .uwx.md records, and .uwpkg.zip deal packages. The gap is a coherent, user-facing set of examples proving how those pieces fit together.

Proposed kit ​

Add a public worked-example kit with:

  1. A lease-abstract-v1 document with source locators, null/status handling, amendments, and a deliberately lossy rent-roll projection.
  2. A source-note-v1 document that carries attributable transcription or diligence context without pretending to be underwriting math.
  3. A collection of rent_roll .uwpart.md fragments, one row per lease, with stable collection keys and provenance.
  4. Standalone operating_statement and cash_flow_series fragments showing T-12 and dated-ledger variants without inventing a deal identity.
  5. An inline .uwx.md deal and an externalized equivalent whose resolved semantic digests match.
  6. A .uwpkg.zip example containing the underwriting record, standalone UW documents, fragments, a manifest, links, and source-evidence references.

The kit should live under examples/standalone/ and be accompanied by named conformance fixtures where behavior is normative: profile validation, fragment standalone parsing, package integrity, and inline/external digest invariance.

Concrete example matrix and conformance mapping ​

Adoption surfaceWorked exampleNamed conformance assertion
lease-abstract-v1 profile plus API shapelease-abstract-v1.uwx.md, lease-abstract.jsonstandalone/profiles/lease-abstract-v1, standalone/lease-abstract/api-shape
source-note-v1 and standalone UWX recordssource-note-v1.uwx.md, inline-deal.uwx.md, externalized-deal.uwx.mdstandalone/profiles/source-note-v1, standalone/profiles/inline-deal, standalone/profiles/externalized-deal
Independently addressable fragmentsparts/*.uwpart.mdstandalone/fragments/standalone-parse
Inline versus externalized compositioninline-deal.uwx.md and externalized-deal.uwx.mdstandalone/composition/inline-external-canonical, standalone/composition/inline-external-digest
Package bytes and context projectionpackage/manifest.json, package/standalone-demo.uwpkg.zipstandalone/package/manifest, standalone/package/integrity, standalone/package/context-boundary

The suite is implemented as a named standalone run in scripts/run-conformance.mjs; it builds the package in memory from the checked in manifest and payloads, so conformance does not depend on a generated ZIP being present in a fresh checkout. The checked-in ZIP remains the user-facing regenerable artifact.

Non-goals ​

This RFC does not add cash-flow-series-v1, rent-roll-v1, or operating-statement-v1 as new document profiles. Those remain sections or fragments until an adopter demonstrates a stable standalone lifecycle that needs its own identity and validation contract. It also does not add lease forecasting, P&L calculations, database storage, OCR, or AI extraction quality requirements.

Definition of done ​

  • A new adopter can choose all-in-one, externalized, or packaged form from examples rather than reverse-engineering the RFCs.
  • Every example parses and validates with explicit provenance and null meaning.
  • Package verification and context projection preserve the documented fidelity boundary.
  • Externalized and inline examples prove semantic-digest equivalence.
  • No example silently upgrades descriptive facts into calculated underwriting claims.

Released under the MIT License.