Um livro
O Framework book é para um livro que você está escrevendo. Para tornar a forma
dele legível, este exemplo o aponta para um que você já conhece: Harry Potter e
a Pedra Filosofal.
A árvore
Seção intitulada “A árvore”DirectoryBook/
- README.md
Directory_eidos/
Directoryshapes/
- frame.premise.md
- frame.reader.md
- frame.voice.md
- frame.market.md
- chapter.full.md
- chapter.sketch.md
Directoryroles/ framework-owner, editor, reader, collaborator
- …
- Framework.md
- me.md pessoal, no gitignore
Directoryframes/
- index.md
- premise.md
- reader.md
- voice.md
- market.md
Directorychapters/
- index.md
Directoryprivet-drive/
- the-boy-who-lived.md
- the-vanishing-glass.md
- letters-from-no-one.md
Directorydiagon-alley/
- the-keeper-of-the-keys.md
- diagon-alley.md
Directoryhogwarts/
- the-sorting-hat.md
- the-mirror-of-erised.md
Directorythe-stone/
- through-the-trapdoor.md
- the-man-with-two-faces.md
- outline.md um documento de nível superior
O livro não tem partes oficiais, então este Framework inventa quatro que coincidem com o modo como a história de fato se move. Isso é uma decisão do Framework: o padrão nunca nomeia um agrupamento por você.
O que ele enquadra
Seção intitulada “O que ele enquadra”| Frame | O que ele resolve |
|---|---|
| premise | O que o livro diz, e por que ele precisa existir |
| reader | Para quem ele é, e o que muda para essa pessoa |
| voice | Pessoa, tempo verbal, registro e as regras que a prosa mantém |
| market | Prateleira, comparáveis e como ele chega aos leitores |
voice é o que não tem contraparte em um Framework de software ou de pesquisa,
e ele ganha o seu lugar: terceira pessoa limitada, passado, colado ao ponto de
vista de uma criança, com o leitor aprendendo o mundo exatamente como ele
aprende. Cada capítulo é julgado contra isso. Uma cena que sai do que ele sabe
quebra o livro, e voice é onde essa regra é escrita uma vez em vez de ser
rediscutida a cada capítulo.
O que o Framework declara
Seção intitulada “O que o Framework declara”### chapters
The book's units, one per chapter, grouped by part.
- **Leaf:** [chapters/index.md](../chapters/index.md)- **Flavors:** - [full](shapes/chapter.full.md) — the complete chapter shape (default). - [sketch](shapes/chapter.sketch.md) — Intent, Open Questions, What Happens, Out of Scope; grow into full.- **Canvas:** card from `## Intent`- **Parts:** - **privet-drive** — the ordinary world, and the letters that break it. - **diagon-alley** — crossing over; the world revealed. - **hogwarts** — school, friendship, and the first hints of the plot. - **the-stone** — the descent, and what waits at the bottom.O shape de chapter
Seção intitulada “O shape de chapter”## Intent → ### Assumptions → ## Open Questions → ## What Happens →
## What the Reader Leaves With → ## Out of Scope → ## Dependencies →
## Notes & Decisions.
Duas seções fazem o trabalho que os critérios de aceitação fazem em uma spec:
## What Happens são os acontecimentos: a trama do capítulo, simplesmente.
## What the Reader Leaves With é o que de fato importa, e é a mais difícil.
Um capítulo pode ter muita coisa acontecendo e não mudar nada para o leitor. Esta
seção é onde você descobre isso antes de escrever.
As propriedades personalizadas dele
Seção intitulada “As propriedades personalizadas dele”| Nome | Tipo | Applies To | Significado |
|---|---|---|---|
status |
Text | all | Draft / Outlined / Drafted / Revised / Final / Cut |
part |
Text | chapters |
O agrupamento, coincidindo com a subpasta |
depends_on |
List | chapters |
Capítulos que o leitor precisa ter lido antes |
Duas coisas dignas de nota. O ciclo de vida termina em Cut, porque um
capítulo que é removido continua sendo uma coisa real de que a raiz deveria dar
conta: ele não é apagado, é registrado como cortado. E depends_on significa
algo diferente aqui do que em software: não “precisa ser construído antes” mas
“o leitor precisa já ter lido isto”, que é preparação, não sequência.
Um Blueprint real
Seção intitulada “Um Blueprint real”---id: the-mirror-of-erisedtitle: The Mirror of Erisedsummary: he finds a mirror that shows him his parents, and has to be told to stop looking.part: hogwartsstatus: Finaldepends_on: - "[The Boy Who Lived](../privet-drive/the-boy-who-lived.md)"connects_to: - "[Through the Trapdoor](../the-stone/through-the-trapdoor.md)"tags: [dumbledore, parents, mirror]---
# The Mirror of Erised
## Intent
The book has told the reader what he lost. This is the chapter that makes himfeel it, by giving him the thing and then taking it away — and it does thatwithout a villain, a spell, or a threat. It also plants the mechanism thatresolves the ending, which is why the object has to be introduced as anemotional problem long before it becomes a plot device.
### Assumptions
Assuming the reader has spent enough chapters in the warmth of Hogwarts tohave half-forgotten the cupboard under the stairs. If the loss is still raw,the mirror lands as cruelty rather than ache.
## Open Questions
- Does Dumbledore appear once here, or twice?- How much of the mirror's rule should be stated versus shown?
## What Happens
Hiding from Filch, he stumbles into a disused classroom and finds a tallmirror. In it he sees his dead family standing around him, alive. He returnson successive nights, brings his friend, who sees something entirelydifferent, and begins to lose sleep. Dumbledore finds him there, explainswhat the mirror does, tells him it will be moved, and warns him againstliving inside it.
## What the Reader Leaves With
That wanting something badly enough to sit in front of it is its own danger.The reader should close the chapter understanding the mirror's rule wellenough to feel the ending coming — without having noticed they were told.
## Out of Scope
- No explanation of where the mirror came from or who made it. The object is a mechanism here, not a mystery; explaining it makes it smaller.- No confrontation. Nothing is threatened in this chapter and nothing is won — the whole weight is a boy sitting on the floor in the dark.
## Dependencies
The reader needs the parents established in the opening chapter, and needs tohave seen enough ordinary school life for the contrast to land.
## Notes & Decisions
Dumbledore arrives without explanation of how he knew. Decided to leave thatunexplained — the reader assumes he simply knows things, and every laterscene benefits from that assumption already being in place.O exemplo Screenplay
Seção intitulada “O exemplo Screenplay”O Eidos distribui uma segunda raiz desenvolvida próxima desta: um curta-metragem,
sobre um Framework cujas coleções foram remodeladas em vez de tiradas de uma
semente:
examples/Screenplay/.
É a mais instrutiva das duas, porque é o caso que nenhuma das três sementes
cobre.