Skip to content

Latest commit

 

History

History
147 lines (124 loc) · 7.29 KB

File metadata and controls

147 lines (124 loc) · 7.29 KB

CodeFrame — Ubiquitous Language

Glossary of domain terms. Terms here are canonical: code, docs, and conversation should use them exactly as defined.

Terms

Drafter(绘图从业者)

The first of CodeFrame's two users (the other is the Contractor): an independent drafter, designer, or design-build firm in California who prepares residential permit drawing packages for clients. The Drafter reviews, completes, and takes professional responsibility for everything CodeFrame draws. CodeFrame never submits anything itself.

Contractor(承包商)

The second of CodeFrame's two users: a CSLB-licensed California contractor who builds a Detached Residence from a finished drawing set and does the office work around the build — reading the set, quantity takeoff, permit coordination, inspection preparation, close-out. The Contractor never draws. What CodeFrame gives them comes from the same Project Config under the same rule as the drawings: stated values only, nothing invented; every judgment, price, and legal document stays theirs (ADR 0006).

Detached Residence(独立住宅)

The business scope: a single-story, wood-frame, detached residential building on a California residential lot — a Detached ADU, an accessory structure (studio, storage), or a single-family house with an attached garage. Attached ADUs, additions, remodels, multi-story buildings, and non-California jurisdictions are out of scope (see ADR 0005).

Detached ADU

A Detached Residence that is an accessory dwelling unit or accessory structure on a lot with an existing primary dwelling. The original v1 scope; the three ADU examples remain the reference for small sets.

Garage(车库)

A room the Drafter declares as the attached garage: unconditioned, so it is listed apart from the living area; its slab sits at its own level and slopes to the door; its walls and door to the house carry the dwelling-garage separation (CRC R302.6). CodeFrame draws what is declared — the room kind, the floor offset, the garage door — and never decides which room is the garage from its name.

Project Config

A structured JSON file describing one Detached Residence project: site, building geometry, openings, roof, and assumptions. Geometry is always explicit — footprint, wall segments, and opening positions are stated, never inferred. It is the single source of truth — every generated artifact must be reproducible from the Project Config alone.

Drawing Skeleton(报建图骨架)

The v1 deliverable: the sheet set a California plan checker expects, A-series (architectural, including the MEP Plans) and S-series (structural), exported as editable DXF (one per view, plus the whole set as paperspace layouts over one model space) and a title-blocked PDF set. Deliberately incomplete: the Drafter finishes details, checks compliance, and signs off. Not a permit set, not construction documents.

Drafting Fidelity(制图精细度)

How closely a Drawing Skeleton follows professional drafting conventions: line-weight hierarchy, symbols, annotation density, sheet composition. A quality of how the sheets read, independent of what they contain.

Set Completeness(图集完整度)

How much of the content a California plan checker expects is present in a Drawing Skeleton: sheets, tables, notes, details. A quality of what the set contains, independent of how it reads.

CAD Editability(可编辑性)

How readily a Drafter can finish a Drawing Skeleton in their CAD tool: whether symbols are blocks or loose lines, dimensions are true dimension entities, layers and text styles follow the conventions their templates expect, and sheets exist as layouts. The third quality of a skeleton, beside Drafting Fidelity and Set Completeness.

Reference Set(参考图集)

A real, publicly available permit drawing set — a county pre-approved plan or a professional firm's approved set — used as the benchmark for Drafting Fidelity and Set Completeness. Measured against, never copied.

Reference Audit(参考图审读)

A Reference Set read into a structured record — who drew it, where, what each sheet carries — and measured against the current Drawing Skeleton: the list of what the set has that the skeleton lacks, each item tagged in or out of scope and stated or derived. Evidence for the drafting conventions, never a change to them by itself.

MEP Plans(设备平面)

The electrical (A2.1), plumbing (A2.2), and mechanical (A2.3) plans: the floor plan ghosted under device symbols, pipe and duct runs, and their terminations, every one at a point or along a path the Drafter stated. They show what goes where; circuiting, pipe sizing, gas load, duct design, and the DWV isometric are the Drafter's work and are noted as such.

Takeoff Skeleton(算量骨架)

The Contractor's deliverable: the quantities that are pure arithmetic on the Project Config's stated values — areas, volumes, lengths, counts — each traceable to the fields it came from. Deliberately incomplete: no waste factors, no unit prices, no labor, no rule-of-thumb counts; every quantity the config cannot state is a BY CONTRACTOR line the Contractor fills. Not an estimate, not a bid.

Massing Model(体量模型)

An optional 3D companion to the Drawing Skeleton: model_3d.step, the building as a few solids (exterior wall shell with openings cut out, interior walls, roof prism), generated from the same Project Config — never reconstructed from the DXF. For owner communication and design review only: not a BIM model, carries no materials or assemblies. Requires FreeCAD (freecadcmd) at generation time; codeframe generate skips it with a notice when FreeCAD is absent (see ADR 0003).

Deterministic Core

The Python package that turns a Project Config into a Drawing Skeleton and a Takeoff Skeleton with no AI involvement. Same input, same output, fully testable offline. It must run standalone from the CLI without any agent present, and it never invents geometry: no auto-layout, no filling in unstated dimensions.

Wall / Elevation Names

Exterior walls are named front, rear, left, and right, where front is the side facing the street. Each wall maps one-to-one onto the drawing of the same name (Front Elevation, Rear Elevation, …), and left/right are as seen when facing the building from the street.

Sleeping Room(卧室)

A room the Drafter declares in the Project Config as used for sleeping (bedroom, or the single room of a studio). Each needs a designated egress window (CRC R310); CodeFrame never guesses which rooms sleep from their names.

Layout Check(布局检查)

Advisory geometry checks the Deterministic Core runs on a Project Config: doorways blocked by fixtures, fixtures clashing or poking through walls, sleeping rooms without a designated egress window. Warnings for the Drafter to judge, never a code-compliance verdict, and never a change to what is drawn.

Layout Review(布局审查)

The Agent Layer's gate before any Drawing Skeleton reaches the Drafter: the Layout Check plus a visual walk of the rendered floor plan. A set is delivered only after both pass or the Drafter explicitly accepts a warning.

Agent Layer

The Claude Code skills that interview the Drafter, fill in the Project Config, and orchestrate the Deterministic Core. The Agent Layer never draws geometry and never bypasses the Project Config.