Document Templates

Project-README.md

Internal project orientation and handoff template. Distinct from an ecosystem-facing README.md — see Manifest Conventions.

# {{PROJECT_NAME}}

## Purpose and boundaries

{{PURPOSE_AND_BOUNDARIES}}

## Governance

- Project record: [`ProjectName.manifest.toml`](ProjectName.manifest.toml)
- Modification instructions: [`AGENTS.md`](AGENTS.md)
- Governing standards: {{GOVERNING_STANDARD_LINKS}}

## Current state

{{CURRENT_STATE_AND_EVIDENCE}}

## Architecture

{{ARCHITECTURE}}

## Repository layout

{{REPOSITORY_LAYOUT}}

## Primary workflows

{{PRIMARY_WORKFLOWS}}

## Build, run, and verification

{{BUILD_RUN_VERIFY}}

## Dependencies and relationships

{{DEPENDENCIES_AND_RELATIONSHIPS}}

## Artifacts, data, and integrity

{{ARTIFACTS_DATA_AND_INTEGRITY}}

## Known gaps and roadmap

{{KNOWN_GAPS_AND_ROADMAP}}

## Handoff notes

{{HANDOFF_NOTES}}

If an ecosystem-facing `README.md` also exists, keep it focused on users and link to this document for project governance and operator context.

Workspace-Health-Record.md

Repeatable workspace health review template. See the filled City Hall Health Record example.

# Workspace Health Record

## Review

- Date:
- Reviewer:
- Root or directory:
- Governing standard:

## State

- Observed state:
- Target state:
- Health state: [unknown / observed / planned / governed / drifted / blocked]

## Evidence

- Manifest:
- Read-first docs:
- Inventory entry:
- Target map entry:

## Gaps

- Gap:
- Impact:

## Next Safe Action

What can be done without losing context or silently changing workspace meaning?