README (Kamae 3)
id
readme
title
README (Kamae 3)
type
definition
requires
- kamae-project-framing
related
[]
entry_points
- README
summary
The project's front-page description, written before the code exists as if the finished thing had already shipped — so the scope has to be decided in order to write it.
depth
1
2
3
· plain
The project's front-page description, written before the code exists as if the finished thing had already shipped — so the scope has to be decided in order to write it.
· definition
The 3 document: the polished project scope, written as if the
project already exists and publishable on day one of the repository Its stem — what the
project is for, who it serves — comes from the ; its technical content from the System
Design
· usage
A forcing function for scope: if you can't describe installing and using the
finished thing, you don't yet know what you're building Living-continuous, edited freely
as the work evolves.
referenced by (derived)
ho-process/ · Kamae (構え) · mutability (living / frozen / sealed)
defining documents: kamae-project-framing §2.3