💡 Om den här guiden
Den här sidan är till för dig som gör din LIA-praktik hos WEBBAB.
Här lär du dig hur vi arbetar med dokumenterad kod och löpande projektdokumentation i Notion.
Syftet är att ge dig en tydlig struktur för hur du kommenterar kod, beskriver tekniska beslut och håller projektinformationen uppdaterad så att alla i teamet snabbt kan sätta sig in i projektets status och struktur.
🎯 Syfte
På WEBBAB värdesätter vi struktur, tydlighet och kunskapsdelning.
Dokumentation är en del av själva utvecklingsarbetet — inte något som görs i efterhand.
Den här guiden visar hur du som LIA-praktikant:
- skriver dokumenterad kod med kommentarer
- håller projektets dokumentation uppdaterad i Notion
💬 1. Skriva dokumenterad kod
✍️ Kommentera med syfte
En bra kommentar beskriver varför något görs – inte bara vad.
Undvik överflödiga kommentarer som upprepar kodens funktionalitet.
Riktlinjer:
- Kommentera ovanför funktioner, klasser och komplex logik
- Följ projektets språkstandard (svenska eller engelska, inte blandat)
- Håll kommentarerna korta och relevanta
- Använd blockkommentarer för större kodavsnitt
Exempel:
🧱 Beskriv funktioner och moduler
Börja varje större fil eller modul med en sammanfattning av syfte och ansvar.
⚙️ Rekommenderade format
Språk | Standard | Format |
JavaScript / TypeScript | JSDoc | /** ... */ |
PHP | PHPDoc | /** ... */ |
Python | Docstrings | """ ... """ |
📘 2. Löpande dokumentation i Notion
🧩 Varför vi använder Notion
Notion är vårt nav för kunskap, struktur och kommunikation.
Här dokumenterar vi projektets:
- mål och syfte
- tekniska beslut
- arkitektur och flöden
- beroenden
- länkar till kod, design och resurser
🗂️ Struktur för projektdokumentation
Varje projekt i Notion ska innehålla följande sektioner:
1️⃣ Projektöversikt
- Kort beskrivning
- Syfte och mål
- Status och ansvariga
2️⃣ Teknisk dokumentation
- Arkitekturöversikt
- Viktiga moduler och komponenter
- API:er och endpoints
- Beroenden
3️⃣ Changelog / Utvecklingslogg
- Kort datumlogg med ändringar och beslut
- Vad som ändrats och varför
4️⃣ Länkar & resurser
- GitHub-repo
- Figma / designlänkar
- Övriga referenser
🔁 Uppdateringsrutin
- Uppdatera Notion vid nya funktioner, större ändringar eller beslut
- För in veckovisa uppdateringar i utvecklingsloggen
- Vid osäkerhet – skriv hellre för mycket än för lite
- Stäm av med handledaren varje vecka
✅ 3. Checklista för LIA-praktikanter
Kommenterar kod som andra kan förstå
Följer projektets språk och kommentarstil
Dokumenterar tekniska beslut i Notion
Skriver veckovisa uppdateringar i utvecklingsloggen
Går igenom dokumentationen med handledare varje vecka
🧩 4. Exempel: Så här ser flödet ut i praktiken
- Du skapar en ny modul för autentisering.
- Du kommenterar huvudfunktionerna i koden.
- Du uppdaterar Notion-sidan under ”Teknisk dokumentation”.
- Du lägger till en rad i utvecklingsloggen:
2025-11-05 — Lade till ny auth-modul (JWT-baserad). Uppdaterar användarflödet enligt beslut från sprint 3.
🚀 5. Sammanfattning
Dokumentation är inte byråkrati — det är teamets kollektiva minne.
När du dokumenterar ordentligt hjälper du både framtida utvecklare och dig själv att förstå hur och varför projektet ser ut som det gör.
Målet: vem som helst ska kunna öppna projektet om sex månader och snabbt fatta läget.
💬 Frågor & support
Vid oklarheter eller behov av hjälp med dokumentationsrutiner, kontakta din handledare eller projektansvarig.
Vi hjälper dig gärna att säkerställa att din dokumentation följer teamets standard.