Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Design proposal template

Copy the Markdown below into a dated proposal file. Replace the date and title, fill in the metadata, and remove the writing prompts as you complete each section. The date is the original submission date. A proposal for new material can adapt the implementation and validation sections to explain the planned text and how it will be reviewed.

# YYYY-MM-DD Proposal title

- Status: Draft
- Author(s): Name(s)
- Discussion: Link to the review or discussion, when available
- Affected chapters: Links to the relevant Accepted Design chapters
- Implementation or experiments: Links, or “Not yet implemented”

## Summary

Describe the proposed change and the outcome it should produce.

## Problem and motivation

Explain the limitation in the accepted design or the gap in the book.
Give a concrete example, workload, or reader need.
Distinguish observations and measurements from assumptions.

## Proposed change

Describe the design or material in enough detail to review it.
Explain how it fits the existing system and what would change.
Clearly label proposed code and behavior that the prototype does not yet implement.

## Alternatives and tradeoffs

Compare plausible alternatives, including keeping the accepted design as it is.
Discuss relevant effects on safety, correctness, performance, complexity,
compatibility, and the reader's understanding.

## Implementation and integration

Identify affected code and chapters, dependencies, and any migration needed.
Explain how the accepted changes would be incorporated into the book and prototype.

## Validation and evidence

Describe the tests, experiments, measurements, or editorial review needed.
Report available results with enough context to reproduce or assess them.
State the acceptance criteria and the limitations of the evidence.

## Open questions

List unresolved choices and the evidence or feedback needed to resolve them.

## Decision and follow-up

Pending review.
When a decision is made, record its date, outcome, and rationale.
If accepted, link to the updated Accepted Design chapters and implementation.
If declined or withdrawn, explain why and any conditions worth revisiting.