59 lines
4.0 KiB
Markdown
59 lines
4.0 KiB
Markdown
# Style Guide for AISE502 Lecture Notes Chapters (LaTeX)
|
||
|
||
> Durable copy — lives in the project so it survives sessions. The LaTeX chapters
|
||
> themselves are the NORMATIVE source for all theory content (ratings, weights,
|
||
> matrix cells); the original master-theory scratchpad file no longer exists.
|
||
|
||
## Project structure
|
||
|
||
- Main file: `AISE502_Vorlesung_Skript.tex` (it `\input`s the chapters)
|
||
- Chapters: `chapters/part1_architecture_decisions.tex` … `chapters/part5_ai_dimension.tex`
|
||
- Bibliography: `references.bib` (natbib, plainnat, authoryear)
|
||
- Compiler: pdflatex + bibtex. No biber, no lualatex, no minted, no svg. `xurl` is loaded (URLs may break anywhere).
|
||
|
||
## Chapter files
|
||
|
||
Each chapter file starts with `\part{...}` and `\label{part:...}`, then `\section`, `\subsection`, `\subsubsection`. NO `\documentclass`, NO preamble, NO `\begin{document}` — files are included via `\input`. Comment separators:
|
||
```latex
|
||
% ============================================
|
||
% SECTION: TITLE
|
||
% ============================================
|
||
```
|
||
|
||
## Language and register
|
||
|
||
- **British English**, academic textbook register, for 5th-semester bachelor students (Python-first; know Git, basic SE, basic ML; have never operated a production system).
|
||
- Didactic rhythm (established in Parts I/II): plain leading question in italics before each pattern/major section; plain-language reasoning first, citation after; every jargon term glossed at first use; concrete anchors from systems students know.
|
||
- The six A1–A6 statements are called **assumptions** ("six load-bearing assumptions"), NOT axioms. "Domain axioms" (ontology invariants) is a distinct, correct term.
|
||
- En-dash style: ` -- `. Quotation marks: LaTeX ``...''.
|
||
|
||
## Environments (tcolorbox)
|
||
|
||
```latex
|
||
\begin{keypoint} ... \end{keypoint} % Key Concept (blue), >=1 per section; maxims live here
|
||
\begin{definitionbox}[Term] ... \end{definitionbox} % formal definitions (yellow)
|
||
\begin{examplebox}[Title] ... \end{examplebox} % worked examples (green); also "Build it and study it" blocks in Part II
|
||
\begin{thinkbox} ... \end{thinkbox} % discussion questions (orange)
|
||
\begin{hinweisbox} ... \end{hinweisbox} % warnings/caveats (red, "Important Note")
|
||
\begin{ailinse}[Title] ... \end{ailinse} % AI lens, Axis A or B (violet)
|
||
\begin{projektbox} ... \end{projektbox} % course-project link (teal)
|
||
```
|
||
Box titles must not contain unbraced commas (pgfkeys); the preamble braces `title={...: #1}` already.
|
||
|
||
## Tables and figures
|
||
|
||
booktabs, no vertical rules; `\caption` + `\label` everywhere; ratings in math mode: `$++$/$+$/$\circ$/$-$/$--$`; very wide tables in `sidewaystable`. TikZ style: rounded rectangles, `\small\sffamily`, fills `!15`/`!20`, Stealth arrows; colours `bankblue`, `bankgreen`, `bankred`, `aiviolet`, `projteal`.
|
||
|
||
## Citations and labels
|
||
|
||
natbib `\citep`/`\citet`, keys must exist in `references.bib` — never invent keys. Canonical cross-chapter labels (do not rename): `part:foundations`, `part:patterns`, `part:applications`, `part:fit`, `part:ai`, `tab:dimensions`, `tab:capability`, `tab:requirements`, `tab:fitmatrix`, `lst:adr`. Part-I didactic tables: `tab:weightexamples`, `tab:patternpreview`, `tab:capexamples`, `tab:minimatch`. Part-II OSS catalogue: `tab:osscatalog`.
|
||
|
||
## Content invariants (normative, verified against the research base)
|
||
|
||
- 7 patterns: L, MM, HX (delta pattern), MS, EDA, PF, SL; agent orchestration as emergent composition pattern (Part V).
|
||
- 10 application classes C1–C10; C10 = AI-native advisory platform (course project).
|
||
- 12 profile dimensions D1–D12 (Table 2); D12 = AI integrability ("queue, port, measurement point").
|
||
- Fit = three-stage non-compensatory procedure (knock-out/shape gate → veto on High weights with documented mitigations → holistic ordinal reading + sensitivity analysis). Never a weighted sum.
|
||
- Matrix verdicts (examples): C10 row L=−, MM=++, HX=++, MS=○; C3 row L=+, MM=++, MS=−−.
|
||
- Capability table has 21 footnotes; requirements table has 17; do not alter ratings without documented evidence.
|