# Spec Framework

|                  |              |
| ---------------- | ------------ |
| **Owner**        | Engineering  |
| **Last Updated** | January 2026 |

***

## Purpose

Build-phase documentation that engineers actually use. Discovery specs (Google Docs) work for sales but rot after kickoff. This framework keeps specs alive during build—in the repo, readable by AI, updated as we go.

## How It Works

{% @mermaid/diagram content="flowchart LR
AUTHOR\[Engineer + AI] --> PR\[Pull Request]
PR --> REV{Review}
REV -->|approved| GH\[(GitHub)]
GH -->|auto-sync| GB\[(GitBook)]
GB --> CLIENT\[Client reads]" %}

1. Engineer drafts spec from template (AI assists)
2. PR review catches gaps
3. Merge to main → GitBook syncs
4. Client reads polished docs without GitHub access

## Three Document Types

| Type               | What It Is                     | Example                           |
| ------------------ | ------------------------------ | --------------------------------- |
| **Spec**           | Project narrative (what + why) | `SPEC-001-client-portal.md`       |
| **ITD**            | Technical decision record      | `AUTH-ITD-001-session-storage.md` |
| **Data Structure** | Entity documentation           | `DS-001-user.md`                  |

## What's In / Out

**In scope:**

* Build-phase specs (live in repo, used during development)
* Technical decisions (ITDs)
* Data models (Data Structures)
* Client delivery (GitBook sync)

**Out of scope:**

* Discovery documentation (teardowns, SME interviews, scope docs)
* Sales artifacts
* Project management

## Documentation

→ [SPEC-000: Framework Spec](/losthex-docs/framework/spec-000-losthex-spec-framework.md) — full details, all ITDs


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://losthex.gitbook.io/losthex-docs/framework/architecture-overview.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.