--- tags: - meta status: granskad aliases: - Konventioner - Stilguide - Renskrivningskonventioner --- > **Syfte:** kontrakt för **renskrivningssteget** i [[index|arbetsflödet]]. Beskriver vad LLM:n får och inte får göra när en stub eller råanteckning städas till en publicerad konceptfil - plus formaterings-, grammatik- och länkningsregler som gäller oavsett vem som skriver. > **Förebild:** [[Variabelbyte i dubbelintegraler]] (struktur), [[Masströghetsmoment (behandlad)]] (renskrivningsstil från råanteckningar). När du är osäker, jämför med dessa. > **Anda:** detta är *riktlinjer*, inte regler. Förstår du tanken bakom kan du själv lista ut formen. --- ## 1. Vad är en konceptfil? En konceptfil beskriver **ett begrepp** - fritt från en specifik kurs, föreläsning eller kontext. Den ska kunna stå för sig själv och länkas till av flera kurser. Begrepp tillhör sällan bara en disciplin: [[Polära koordinater]] används lika mycket i fysiken som i matematiken; en [[Derivata]] är samma sak oavsett om vi betraktar den i envariabelanalysen eller i en Lagrangefunktion. Konceptet får gärna vara **abstrakt**. Det behöver inte vara en formel med ett `\boxed{}` runt en konceptfil kan lika gärna handla om *en idé* (ortogonalitet, kontinuitet, kausalitet) som om en konkret räkneoperation. > [!important] Tre frågor som måste besvaras > Läsaren ska efter sidan kunna svara på: > 1. **Vad är det här?** Definition tidigt, inte begravd i exempel. > 2. **Varför finns det / varför bryr vi oss?** Motivation, intuition eller härledning. > 3. **Hur används det?** Minst ett konkret exempel — eller, om begreppet är rent kvalitativt, en pekare till var det dyker upp. --- ## 2. AI:ns roll i renskrivningen Detta är **kärnan**. Allt nedan utgår från att en LLM gör renskrivningen, men författaren har gjort föreläsningen, kursboksläsningen och stub-fyllandet själv. > [!important] Grundprincip > **AI putsar — AI tänker inte.** Innehåll, slutsatser och resonemang kommer från författaren. AI:s roll är layout, språk och korsreferenser, inte begreppslig synthese. > [!tip] Vad AI får göra > - **Stavning och grammatik** — tyst rättning, inga frågor. > - **Strukturera om** löpande prosa till numrerade sektioner, callouts, tabeller. > - **Foga in `\boxed{}`, `\dfrac`, `\,dx`** och annan typografisk LaTeX där originalet är slarvigt. > - **Generera bilder** (matplotlib, plotly) för geometriska påståenden som finns i texten men saknar illustration. > - **Föreslå korslänkar** till andra konceptfiler (förstanämnande-regeln gäller, se §7). > - **Lägga till `## Läsning` / `## Se även` / `## Resurser`** baserat på frontmatter och kursens kurslitteratur. > - **Uppdatera frontmatter** så att aliases, taggar och status stämmer. > [!warning] Vad AI inte får göra > - **Uppfinna matematik.** Om en formel saknas i underlaget — låt den fortsatt saknas. Hellre lucka än hallucination. > - **Lägga till exempel som inte fanns i originalet.** Författaren väljer vilka exempel som är värda att räkna. > - **Skriva om slutsatser eller intuitionsförklaringar.** Den filosofiska delen är författarens röst. > - **Byta ut författarens egna skisser/foton** mot AI-genererade bilder. Generera *kompletterande*, inte *ersättande*. > - **Ändra fackspråk till "lättare" språk** ("derivata" → "ändringshastighet"). Behåll terminologin. > - **Lägga till disclaimers, sammanfattningar eller "Vad du lärt dig"-sektioner** som inte fanns i underlaget. > [!note] Tillåtna tillägg > Korta klargöranden får läggas till om — och bara om — texten kräver det: > > - Definition av en term som *används* i originalet utan att förklaras (t.ex. "vinkelräta avståndet" om det dyker upp utan kommentar). > - En **rimlighetskoll** i slutet av ett exempel där facit är uppenbart geometriskt eller dimensionellt. > - En **sammanfattningstabell** som *syntetiserar* spridd information, inte tillför ny. > - En **mellanrubrik i fetstil** för att bryta upp ett långt resonemang. > > Allt utöver detta — fråga författaren. --- ## 3. Renskrivningsrutinen — steg för steg > [!important] Ordning på operationer > 1. **Läs hela underlaget.** Förstå strukturen innan du flyttar något. > 2. **Frontmatter först.** Sätt `kurs`, `tags`, `förkunskaper`, `status: utkast`, `aliases`. > 3. **Identifiera sektioner.** Vad är definition? Härledning? Exempel? Tabell? > 4. **Numrera huvudsektioner** (`## 1.`, `## 2.`, …). Slut-sektionerna numreras *inte*. > 5. **Lyft ut callouts.** Allt som är "se upp", "tips", "intuition" → callout (se §5). > 6. **Putsa matematiken** typografiskt — `\boxed{}`, `\dfrac`, mellanslag, ändrade variabler för konsekvens. > 7. **Bilder sist.** Bilder genereras när texten är klar, så palett och proportioner kan sättas mot innehållet. > 8. **Footer sist.** `## Läsning` / `## Se även` / `## Resurser`. > 9. **Aldrig** ändra status från `utkast` till `granskad`. Det är författarens beslut. --- ## 4. Strukturen i kroppen ```markdown # > **Kurs:** > **Förkunskaper:** [[...]] --- ## 1. ... ## N. ## Läsning ## Se även ## Resurser ``` > [!tip] Regler för struktur > - **Numrera huvudsektioner** (`## 1.`, `## 2.`, …) — undantag: footer-sektionerna. > - **`---` mellan numrerade sektioner**, inte före *Läsning*. > - Första sektionen *definierar* eller *motiverar* begreppet. > - Sista numrerade sektionen är typiskt en sammanfattning eller metodikchecklista. > - **3–9 sektioner** är hälsosamt. Färre → tunn. Fler → spretig. --- ## 5. Callouts Callouts är inte dekoration — de signalerar *vad* texten gör. Använd dem så att läsaren kan skanna sidan och se rytmen i innehållet. | Callout | När | |---|---| | `> [!abstract]` | Grundtanken — en mening som sammanfattar hela noten | | `> [!note]` | Subtil men viktig precisering | | `> [!important]` | Det studenten ska lägga på minnet | | `> [!warning]` | Vanliga fel, fallgropar | | `> [!tip]` | Tricks, intuition, mnemonics | | `> [!example]-` | Exempel — **alltid** kollapsbart (bindestrecket efter `]`) | > [!important] Exempel ska vara kollapsbara > `> [!example]- Titel` med bindestreck. Då kan noten läsas som översikt och exemplen veckas ut på begäran. Aldrig `> [!example]` utan bindestreck. > [!warning] Spamma inte callouts > En sida med tio `[!important]` säger inte vad som faktiskt är viktigt. Tumregel: **en `[!abstract]` per sida, max 2–3 `[!important]`.** --- ## 6. Matematik och formler > [!tip] Typografiska standarder > - **Inline:** `$f(x)=\sin x$`. > - **Display:** `$$ ... $$` på egen rad. > - **Nyckelformler:** `\boxed{...}`. Sparsamt: 1–4 per fil, det som ska *minnas*. > - **Bråk i display-läge:** `\dfrac` istället för `\frac`. > - **Differentialer:** `\,dx`, `\,d\theta` (smal mellanrum). > - **Vektorer:** `\vec a`, `\vec b`. Inte fet stil. > [!warning] Inga `\tfrac` i bildtexter > Matplotlibs mathtext stöder *inte* `\tfrac`. Använd `\frac{1}{2}` när du genererar bilder. > [!note] Variabelkonvention > - Polära: $r,\theta$ (inte $\rho,\varphi$ utan anledning). > - Tid: $t$. Position: $x,y,z$ eller $\vec r$. > - Vinkelhastighet: $\omega$. Vinkelacceleration: $\alpha$. > - Behåll författarens val om det är konsekvent inom filen — ändra bara när det krockar inom samma sida. --- ## 7. Länkning > [!important] Förstanämnande-regeln > Länka ett begrepp **bara första gången** det dyker upp i brödtexten. Övriga omnämnanden lämnas oformaterade. Detta är fast praxis sedan 2026-04-23. > [!tip] Övriga länkningsregler > - **Aldrig självlänka.** En `Derivata.md` länkar inte `[[Derivata]]` inuti sig. > - **Använd alias för läsbarhet:** `[[Gränsvärden|gränsvärdet]]` istället för `[[Gränsvärden]]`. > - **Länka aldrig inuti:** frontmatter, kodblock, mathblock (`$...$` eller `$$...$$`), rubriker, eller `> **Kurs:** ...`-blockcitatet. > - **Generiska ord länkas inte:** *funktion*, *metod*, *variabel*, *argument*. Lista i `/tmp/crosslink.py`. > [!note] `## Se även` är en undantagszon > Där får du upprepa länkar som redan finns inline — det är en navigationssektion, inte brödtext. --- ## 8. Bilder > [!tip] Prioritetsordning för bilder > 1. **Kurslitteratur** (skärmdump, beskuren). > 2. **Internet** (med källangivelse). > 3. **AI-genererat** (matplotlib/plotly). > > Bilder är *valfria*. Geometriska eller spatiala påståenden ska ha bild; rent algebraiska eller filosofiska behöver ingen. > [!important] Vaultens palett > ```python > BG = "#fcfaf7" # bakgrund > FG = "#0f0f10" # text/axlar > ACCENT = "#2f4858" # kanter, accenter, viktiga vektorer > SHADE = "#86a59c" # sekundär färg > SHADE_LIGHT = "#c9dad3" # fyllning av områden > GRID = "#d8d2c8" # axelraster > ``` > **PNG på 160 DPI**, typsnitt **serif** (`"font.family": "serif"`). **Embed-syntax:** ```markdown ![[exempel4-xy.png|420]] ``` > [!note] Bildbredd är riktvärde > Quartz skalar ner ändå. > - **360–420** för enstaka diagram inne i exempel-callout. > - **500–640** för figur i löpande text eller sida-vid-sida-jämförelse. --- ## 9. Frontmatter ```yaml --- kurs: - # ex. M0068M tags: - # ex. matematik - # ex. flervariabelanalys - # ex. integral förkunskaper: - "[[...]]" status: utkast | granskad | publicerad aliases: - - --- ``` > [!note] Statusens betydelse > - **utkast** — stub eller råanteckning. *Läs på egen risk.* > - **granskad** — författaren har läst igenom och står för innehållet. > - **publicerad** — kvalitetsgranskad, redo för andra studenter. > > AI får aldrig själv höja status. Det är författarens beslut efter genomläsning. --- ## 10. Footer — slut-sektionerna ### `## Läsning` PDF-djuplänkar till kursböckerna i `meta/böcker/`. Sidnummer **får inte gissas** — använd `pypdf` för att läsa innehållsförteckningen. ```markdown - [[z.Calculus A Complete Course 10th.pdf#page=873|15.4 Double Integrals in Polar Coordinates]] - [[University Physics with Modern Physics in SI Units.pdf#page=412|10.3 Rotational Kinetic Energy]] ``` För kurser utan referensbok i vaulten (M0067M, D0009E) **utesluts sektionen helt** — lägg inte till tomma platshållare. ### `## Se även` Wiki-länkar till syskonbegrepp i `koncept/`. **3–8 länkar** är normalt; mer än det betyder att man försöker göra MOC, vilket konceptfiler inte är till för. ```markdown - [[Dubbelintegraler]] - [[Variabelbyte i trippelintegraler]] - [[Polära koordinater]] ``` ### `## Resurser` Externa länkar för fördjupning. **Prioritetsordning:** 1. **3Blue1Brown** — om en relevant video finns. Lägg den först. 2. **Khan Academy / MIT OCW** — för algoritmiska genomgångar. 3. **Wikipedia** — alltid acceptabelt som sista fallback. ```markdown - [3Blue1Brown: ]() — kort kommentar varför den är värd att se - [Khan Academy: ]() - [Wikipedia: ]() ``` --- ## 11. Språk och stil > [!tip] Riktlinjer > - **Brödtext på svenska.** Tekniska termer på svenska om de finns; engelska bara när det inte finns en etablerad svensk variant. > - **Kodblock, nyckelord och variabler på engelska.** > - **"Vi" som subjekt** ("Vi byter koordinater för att…") — inte "man" eller passivum. > - **Aktiv form > passiv form.** "Determinanten ger…" är bättre än "Determinanten är given av…". > - **Inga emojis. Inga skämt.** Det är studielitteratur. > - **Inga "Ordlista svenska ↔ engelska"-tabeller.** Globalt borttagna 2026-04-23 — ska aldrig återinföras. > [!warning] Behåll författarens röst > Om författaren skriver "tröghetsmomentet förhåller sig till rotation som massan förhåller sig till translation" — skriv inte om till "$I$ är rotationens analog till $m$". Den första är prosa, den andra är formelspråk. Båda har plats, men byt inte ut den ena mot den andra. --- ## 12. Vad som ALDRIG ska göras > [!warning] Förbjudet > - **Uppfinna mattetalter eller fakta.** Hellre tom sektion än hallucination. > - **Markera utkast som granskad.** Status höjs av författaren, inte AI. > - **Lägga till exempel som inte fanns i underlaget.** > - **Byta ut författarens röst** mot en mer "akademisk" eller mer "lättfattlig". > - **Återinföra Ordlista-tabeller.** > - **Skapa noter för framtida kurser** (Åk2+ tills författaren själv kommit dit). > - **Skapa noter i `meta/raw course dump/`** — den katalogen är read-only källmaterial. > - **Pusha utan kontroll.** Författaren läser alltid igenom innan commit. --- ## 13. Checklista innan `utkast → granskad` > [!important] Innan status höjs > - [ ] Frontmatter komplett och korrekt. > - [ ] `> **Kurs:**` / `> **Förkunskaper:**` matchar frontmatter. > - [ ] Sektioner numrerade `## 1. ...`, slut-sektioner inte numrerade. > - [ ] Minst ett **fullt utfört exempel** med rimlighetskoll och `\boxed{}` slutsvar (om relevant). > - [ ] Geometriska påståenden har minst **en bild**. > - [ ] Förstanämnande-länkning gjord. > - [ ] **Inga självlänkar.** > - [ ] `## Läsning` / `## Se även` / `## Resurser` på plats (eller medvetet utelämnade). > - [ ] Inga AI-tillägg utöver det som §2 tillåter. > - [ ] Stavning och grammatik kontrollerad — körd genom egen läsning. --- ## Se även - [[index]] — beskriver hela arbetsflödet som dessa konventioner är en del av. - [[Variabelbyte i dubbelintegraler]] — förebild för struktur, exempel och bildanvändning. - [[Masströghetsmoment (behandlad)]] — förebild för hur en råanteckning ser ut efter renskrivning. ## Resurser - [Obsidian callouts](https://help.obsidian.md/Editing+and+formatting/Callouts) - [Quartz docs: authoring](https://quartz.jzhao.xyz/authoring-content)