update
This commit is contained in:
@@ -47,7 +47,8 @@ A **topic inventory** is produced beforehand by a research agent and supplied to
|
||||
- Open each chapter with a one- or two-sentence **lead** (`.lead`) that frames why the topic matters.
|
||||
- Explain each new term the first time it appears. Assume an intelligent reader who is new to *this* subject.
|
||||
- Prefer **short, concrete examples** over abstract description. For technical topics that means small code snippets; for non-technical topics it means worked examples, sample dialogues, before/after comparisons, small tables, checklists, or step lists.
|
||||
- Use **callouts** to highlight tips, warnings, side-notes, and deeper digressions — not more than one or two per chapter.
|
||||
- **Explanations are short and simple**: max. 3 short main clauses per concept, no nested sentences. Plain language over precision-flexing.
|
||||
- Use **callouts** to highlight tips, warnings, side-notes, and deeper digressions — not more than one or two per chapter. Sentences like "Empfehlung: …", "In der Praxis problematisch: …", "Achtung: …" ALWAYS go into the matching callout (tip/warn/note), never into running explanation text.
|
||||
- Keep prose tight. This is a reference people skim and return to, not an essay.
|
||||
|
||||
---
|
||||
@@ -752,6 +753,7 @@ Example (PHP-flavored, but the pattern is language-agnostic):
|
||||
- [ ] TOC lists every part and every chapter, sequential numbering
|
||||
- [ ] Each part has a divider; each chapter starts with `.chapter-head` + `.lead`
|
||||
- [ ] Callouts used sparingly (≤ ~2 per chapter), correct flavor
|
||||
- [ ] Explanations ≤ 3 short main clauses; recommendations/warnings live in callouts, not prose
|
||||
- [ ] Tables for comparisons/lists; code blocks only if technical, short, escaped
|
||||
- [ ] Prose in the reader's language; terms explained on first use
|
||||
- [ ] Built with WeasyPrint and **visually verified** by rendering pages
|
||||
|
||||
Reference in New Issue
Block a user