tillbaka till startsidan

46. Stack-Ove & Kjell Kod

Lyssna på Spotify lyssna! Lyssna på iTunes

Dokumentationsbonanza! Egen dokumentation i form av kommentarer och readmes samt ramverks dokumentation och guider. Är frågor på “Stack-Ove” dokumentation? Är det en superkraft att vara duktig på att läsa dokumentation? Den eviga känslan att det är jobbigt att uppdatera dokumentation samt mycket mycket annat.

Om du gillar podden blir vi väldigt glada för en liten recension i iTunes eller en prenumeration på Spotify. Följ oss och säg hej på @asdfpodden på Instagram eller Twitter (Anton, Therése) <3

Länkar

Avsnittets skämt:

Vad sa utvecklaren som blev medbjuden på padel?
Tack, men jag föredrar att squasha!
Skrapa här!!
Transkribering
Transkriberingen är gjord av nån "AI-grej". Du kan förbättra den genom att klicka precis här :)
00:00:00
Vad sa utvecklaren som blev medbjuden på paddel?
00:00:04
Jag har ingen aning.
00:00:08
Tack, men jag föredrar att squasha.
00:00:12
Det var kul. Är det ett eget skämt eller något du har hittat?
00:00:18
Nej men det är ett eget, men faktiskt var det min PM/PO, vad det nu är för roll, som sa någonting om paddel när jag sa skorsa i förbifarten.
00:00:30
Så då tänkte jag att här finns det något.
00:00:32
Ja det förstår jag, det var ändå roligt tycker jag.
00:00:36
Det var bra kvalitet på det.
00:00:39
Ja men det känns lite nutida också.
00:00:41
Ja verkligen, det är inte så aktivt när folk lyssnar på det här om tio år och tänker vad fan är paddel för något.
00:00:46
Du hoppas det eller?
00:00:48
Ja, gud ja. Någon kommer inte ihåg Puddle Crasen 2021.
00:00:52
Eller när fan det var när det exploderade som mest.
00:00:54
Är inte det typ någon OS-gren eller något nu?
00:00:57
Jo, kanske. Det kanske är.
00:00:59
Jag vet inte om det är optimistiskt eller pessimistiskt att tänka att det är bortglömt om tio år.
00:01:04
Nej, jag vet inte. Jag har aldrig provat. Jag ska inte uttala mig.
00:01:08
Och där pratar jag om sport. Det ska jag inte heller göra.
00:01:12
Det är säkert så finkul, jag brukar spela badminton så det är säkert minst lika roligt.
00:01:17
Men välkomna till ett nytt avsnitt av ASDF.
00:01:21
Jag har vaccinerat mig för ganska precis sex timmar sedan typ.
00:01:26
Så jag tänker att någon gång under det här timmet så kommer bieffekterna slå till.
00:01:30
Så får vi se om det blir en halvtimme eller inte.
00:01:33
Än så länge lite stel i kroppen och lite ont i armen men annars ganska lönt.
00:01:37
Jag fick full blown influensa va?
00:01:42
Ja det var det. Jag har hört att den här booster dosen är inte så snäll mot de flesta.
00:01:49
Så vi får se om det blir ett helt avsnitt eller inte. Men än så länge känns det bra.
00:01:54
Så jag tänker att om jag pratar snabbt så kan jag bara sänka hastigheten på avsnittet sen.
00:01:57
Och så blir det en halvtimme.
00:01:59
Okej.
00:02:04
Jo, jag funderade på lite grann, vi kanske har berört det här i något gammalt avsnitt eller liksom glidit in på det i något sidospår
00:02:13
för det brukar ju bli några stycken sådana.
00:02:15
Men jag tänkte vi skulle snacka lite dokumentation och kanske lite ur lite olika perspektiv.
00:02:23
Men jag tänker vi kan börja med liksom dokumentation för att det känns som att dokumentation är något som alla utvecklare hatar
00:02:30
Alltså att göra, det vill säga.
00:02:32
I att skriva dokumentation.
00:02:35
Och det kommer då ofta ur perspektivet att man ska göra det för sin egen app eller sin egen tjänst eller vad man nu utvecklar.
00:02:41
Men hur mycket dokumentation har du skrivit i dina dagar i relation till kodet till exempel?
00:02:47
Ouff.
00:02:49
Ja, det är ju mer kod.
00:02:54
Det är en övervikt mot kod skulle jag säga.
00:02:58
– Du då? – Ja, men verkligen.
00:03:01
Nej, jag känner exakt likadant.
00:03:04
Och jag har också varit, i början av min karriär särskilt, då var jag så här
00:03:07
"Ja, fy fan, vad tråkigt att skriva dokumentation på hur saker fungerar."
00:03:12
Men sen har det kanske skiftat lite grann, så nu känner man ändå så här
00:03:17
"Ja, jag förstår varför dokumentation behövs i vissa fall."
00:03:21
Och då kanske det är lite lättare att ta det steg där man faktiskt skriver dokumentationen
00:03:25
än om man bara skriver den för att någon har sagt åt den att skriva den.
00:03:29
- Jo, alltså, jag menar dokumentation har ju verkligen en plats egentligen.
00:03:34
Det är ju bara mer att jag får någon slags...
00:03:38
lite... det är lite ångestfyllt att skriva dokumentation, för att helt plötsligt så måste du
00:03:44
formulera vad det är du håller på med.
00:03:47
Alltså en sak som är jättebra, det är ju att dokumentera beslut som har tagits.
00:03:51
Men hur fan formulerar jag det? Jag får lite så här "rapport i skolan ångest" liksom.
00:03:58
Ja, exakt. Jag håller verkligen med dig. Det måste vara rätt typ av dokumentation för att det ska bli värt det.
00:04:05
Alltså till exempel som du säger, att man skriver dokumentation som förklarar beslut,
00:04:08
eller varför någonting har gjorts snarare än att man skriver dokumentation som förklarar koden.
00:04:13
För dem är ofta ganska värtlös.
00:04:15
Ja, ibland kan jag komma in i system och verkligen känna att nu går dokumentationen bra. Skriver ner allt jag vet och gör det.
00:04:24
Men det värsta jag vet, förutom att skriva dokumentation, det är att uppdatera dokumentation.
00:04:33
Så jag tror det är det som håller mig tillbaka. Skriver dokumentation, sen ska jag uppdatera rätt delar av det.
00:04:41
missar alltid någonting och sedan helt plötsligt så har den dött.
00:04:45
Det är svårt för det.
00:04:48
Ja, jag förstår det.
00:04:50
Nej, jag är verkligen på samma sida också.
00:04:53
Det är ju lite så här
00:04:55
någonting med dokumentation som gör att man bara tar emot litegrann.
00:04:58
Jag vet inte, för mig tror jag att det kanske beror på också, eller i alla fall
00:05:01
berodde mer på i början, att det är en stor skillnad på att skriva kod som man
00:05:06
tänker att "ja, men det har jag liksom lärt mig hur man gör".
00:05:08
Och sen att jag plötsligt skriver dokumentation, för det är inte så lätt att skriva bra dokumentation.
00:05:12
Alltså det är liksom en helt annan färdighet än att skriva kod till exempel.
00:05:17
Ja, verkligen.
00:05:19
Men det ska vara tydligt och...
00:05:21
Alltså jag brukar ofta fastna också i det visuella, att jag vill att det ska vara konsekvent.
00:05:25
Om jag har möjlighet att formatera vissa saker.
00:05:28
"Okej, men jag använder en sådan här heading för den här överskriften."
00:05:31
"Borde inte det vara en subheading till den här?"
00:05:33
Alltså jag fastnar liksom i saker runtomkring.
00:05:38
Ja, jag är också så här. Jag har verkligen märkt det att man måste träna upp dokumentationsskrivandet.
00:05:47
Jag tror att det är samma sak som att skriva tekniska artiklar eller vad det nu kan vara med så mycket teknisk innehåll.
00:05:53
Eller manualer förr i tiden, för nu finns det inte så många manualer.
00:05:58
Det är samma färdighet att dokumentation måste man träna på.
00:06:03
Skriva ganska dålig dokumentation innan man kan skriva bra dokumentation.
00:06:07
Ja, men det tror jag, det är nog verkligen en grej. Jag gick ett år kognitionsvetenskap, till exempel.
00:06:15
Och därifrån har jag för detta klasskompisar, som jobbar eller har jobbat med att enbart skriva säkerhetsmanualer.
00:06:25
För att det är den här människa-maskin-interaktionen och vad som händer i den mänskliga hjärnan när man får stresspåslag,
00:06:31
har en så stor effekt på hur man uppfattar saker.
00:06:34
Så det är ju verkligen en liten vetenskap att skriva dokumentation.
00:06:39
Ja, eller hur?
00:06:41
Och sen så är det också så här, man måste anpassa sig, för det finns ju så jävla många typer av dokumentationer som man tittar på.
00:06:46
Kodkommentarer, som kanske ska vara fem rader långa, typ, max.
00:06:51
Då måste man verkligen vara konsekvent och tydlig med vad kommentaren tillför för värde, och varför man ska läsa den.
00:06:59
Annars skippar folk också att läsa kommentarerna.
00:07:02
Och då hjälper det ingenting.
00:07:05
Nej. Jag tycker det är en fine line också med att jag tenderar att lägga till en massa extra ord.
00:07:13
Så jag brukar få jobba ganska mycket med att plocka bort ord.
00:07:16
Men när det är jättekompakt, då är det ju en extrem torma som uppstår också.
00:07:22
Och där tänker jag att man inte heller vill hamna. Alltid.
00:07:25
Samtidigt känns det som att man hellre hamnar där, att det är väldigt kort och konsekvent än att det är utdraget och tråkigt för att det är långt.
00:07:34
Jag är på samma ställe som dig. När jag skriver i artiklar till exempel, då jobbar jag väldigt hårt på att läsa in den här meningen. Hur många ord kan jag ta bort utan att det blir alltför torrt eller att den byter innebörd?
00:07:49
Ja, absolut. Men jag är ju också extremt dålig på att läsa dokumentation.
00:07:58
Det är fruktansvärt.
00:08:03
Det borde jag kanske vara bra på när jag jobbar med det här.
00:08:07
När det kommer en enorm textmassa före över, då är det som att jag bara stänger ner.
00:08:14
Den är dessutom torr. Jag kan läsa samma mening typ tio gånger och ändå inte förstår den.
00:08:20
- Ja, där tror jag att jag är jävligt bra på att läsa.
00:08:29
Jag tror att det är generellt för text överlag, för jag har läst extremt mycket böcker, särskilt när jag var liten.
00:08:36
Både på engelska och svenska.
00:08:38
Jag är väldigt duktig på att skumma texter, till exempel bara för att hitta information.
00:08:43
Eller om man vill hitta innebörden i en text så är jag ganska bra på att skumläsa den och hoppa över vissa ord som jag vet inte behövs.
00:08:51
Jag har inte tänkt på det förut, men nu när du svarar så tänker jag att det kanske hjälper ganska mycket just i dokumentationsfallet också.
00:08:58
Då kan jag väldigt snabbt skumma en dokumentation utan att bli uttråkad på vägen och faktiskt hitta det jag är ute efter.
00:09:05
Gud ja, det tror jag. Alltså jag fastnar ju.
00:09:08
Om jag läser, om jag säger till en bloggpost,
00:09:11
så är det ett inledande stycke, så läser jag det ord för ord
00:09:14
och så fastnar jag på typ så här två ord som jag inte förstår.
00:09:17
Då fastnar jag på dem. Sitter fast där. Antingen upprörd,
00:09:20
eller så måste jag kolla upp vad det är, så måste jag försöka sätta in dem i sitt sammanhang.
00:09:24
Men jag fastnar där. Och så kan jag vara så här,
00:09:26
"Vad betyder det här, vad betyder det här?" Så skickar jag länken till någon.
00:09:29
Och de bara, "Jo men svaret kommer i stycket under om du bara fortsätter läsa."
00:09:33
Men det gör inte jag. Jag sitter fast där och är arg.
00:09:37
Ja, det är ju ändå spännande.
00:09:41
För det är inte något jag har tänkt på förut.
00:09:43
Jag har ju uppfattat att folk inte läser så mycket dokumentation.
00:09:47
Eller att man bara "jag hittar ingenting i dokumentationen".
00:09:50
Och så går jag själv och tittar och bara "men det står ju där".
00:09:54
Men jag vet inte. Det kanske också är en anledning till att nu för tiden läser jag
00:09:58
extremt mycket dokumentation på saker jag använder.
00:10:01
Det är sällan jag gått stackoverflow nu för tiden, om det inte är något specifikt problem mellan kopplingen mellan fyra olika bibliotek som man ska hitta någon lösning på.
00:10:12
Då kan stackoverflow vara bra. Men annars är det någonting med ett javanskript bibliotek till exempel, då är dokumentationen dit jag går först.
00:10:22
Det här är någon slags superior skillnad. Jag går till dokumentation, läser, förstår inte, blir arg, googlar, hamnar av stackove, skummar, fattar inte, blir arg och googlar upp något nytt.
00:10:37
Jag har ju ett väldigt dåligt sätt att arbeta.
00:10:41
Men det är lite intressant att du kan hoppa över viktiga saker och grejer. Det måste vara så himla skönt.
00:10:47
Jag har ju helt andra hållet. Jag har ju verkligen problem med det här.
00:10:52
Och då har jag ändå läst ganska mycket tidigare.
00:10:56
Jag kan läsa, alltså dålig däckare kan jag läsa fort. Det går undan.
00:11:02
Men det var också kul då, för vi hade user testing för ett system.
00:11:08
Och då är det så här, UX-aren bara "ja men var med, skriv ner saker som du finner intressanta"
00:11:14
Och mina kollegor, de är bra på det. Jag skriver ganska lite. Jag skriver bara upp saker som är intressanta.
00:11:19
Jag är så här, jag typ transkriberar allting som sägs.
00:11:23
För att jag bara, jag vet inte vad som är viktigt. Jag har med allt.
00:11:27
Jag kan inte sålla. Det går för fort liksom. Det funkar inte.
00:11:32
Jag sållar ju extremt mycket.
00:11:34
Alltså, verkligen att jag kan skriva en mening på en presentation på 20 minuter.
00:11:39
Det här var det. Take awayen.
00:11:42
Det är det som kommer åka. Sen visst att det är backfire ibland att "oj, missade den här grejen"
00:11:48
Men fan, hellre det än att sitta och transkribera 20 minuter.
00:11:52
[Skratt]
00:11:56
- Ja, jag önskar verkligen att jag hade den dokumentationsläsaren-skillen.
00:12:02
Jag har fått träna något enormt. Och också träna mig på det som kommer naturligt för många.
00:12:09
Jag har ju för många, även dig tror jag, att dokumentationen inte ger mig det jag vill.
00:12:15
Så jag går in och läser lite källkod.
00:12:17
Det sitter också ganska långt inne för mig att göra det.
00:12:21
- Ja, för det kan jag också göra. Jag kan gå in i källkoden för något bibliotek och kolla.
00:12:26
Hur funkar det egentligen? Varför funkar det inte som jag har tänkt?
00:12:29
Vad gör den i bakgrunden?
00:12:31
Och så, innan jag glömmer bort det här.
00:12:33
Stack Ove. Älskar uttrycket, aldrig hört det förut tror jag.
00:12:37
[Skratt]
00:12:40
- Ja, okej. Det var nog någon gammal universitetsgrej. - Ja, Stackover.
00:12:46
- Ja, att vi skulle välja namn som var teknikerrelaterade, men på svenska. Så var det någon som valde Stackover.
00:12:53
- Jag tycker det är... - Det var någon som hette Källkod också.
00:12:56
- Ja, den är också rolig. Väldigt kul. Vet du vad det finns? Det finns stickerspotential här.
00:13:01
Om jag bara kunde designa, då hade det varit stickers.
00:13:05
Jo, sidospår deluxe. Men, vart var vi?
00:13:10
Dokumentation. Jag tänker också så här, Stack Overflow är ju egentligen dokumentation.
00:13:15
Även om det ska vara en wiki eller en Q&A-sida.
00:13:19
Men det blir ju i förlängningen dokumentation på hur man gör saker.
00:13:23
Kanske inte som jag sa tidigare, hur det här biblioteket fungerar.
00:13:26
Men snarare, hur integrerar jag den här saken x med y när jag bygger det på z?
00:13:33
Men det är ganska intressant att den dokumentationen finns och man kan tycka ganska mycket om stack OV.
00:13:40
Men jag kan förstå deras ambition när de har så hårda regler.
00:13:48
Att det här ska vara dokumentation, det ska vara på samma nivå som om du går in på biblioteks dokumentation och läser.
00:13:57
Ja, men det är också intressant för att i Kärplastik så känns det som att man har öppnat upp lite begreppet för dokumentation.
00:14:05
För mig när jag tänker dokumentation i den här världen, då är det ju liksom, där är ett lib, här är typ referenserna, APIerna och så är det mycket text liksom.
00:14:15
Och så ska man förklara varenda funktion som finns.
00:14:18
Men som du säger, jag menar allting som vi skriver ner gällande sakerna vi håller på med är ju någon typ av dokumentation liksom.
00:14:26
Ja, nämen exakt.
00:14:28
Likväl tickets som vi jobbar med, det är också dokumentation.
00:14:32
Ja, absolut. Där vet jag att jag är jävligt kass egentligen.
00:14:37
Vi diskuterade det senaste i dag faktiskt på jobbet.
00:14:40
Att vi borde skriva ner mer saker i tickets.
00:14:43
Till exempel vilka beslut som är tagna i den här ticketen.
00:14:46
Om man har gjort någon avsteg från vad som var kravet från början till exempel.
00:14:49
Sådana saker måste vi bli bättre på att faktiskt skriva ner.
00:14:53
För det är ju dokumentation som lever tills vi lever vidare liksom och är skitbra att ha om en månad eller två när vi tittar tillbaka på det här.
00:15:00
"Varför gjorde vi inte så här?"
00:15:02
- Ja, så är det verkligen. Jag är ju verkligen en person som hade en period där jag bara gjorde one-liners.
00:15:08
Eller vad jag menar, i allhetens namn. Jag är fortfarande en person som kan göra one-line-tickets liksom.
00:15:13
Och sen gå tillbaka och bara "Vad fan var det här?"
00:15:16
Så där har jag också verkligen tränat på att bara skriva ner saker.
00:15:22
Och det är inte heller så att det alltid måste vara rätt.
00:15:24
Jag använder kommentarsfält i Tickets, om det nu finns, ganska mycket för att få ner saker utan att det finns någon press på att det måste formuleras helt korrekt.
00:15:37
Eller formateras helt korrekt.
00:15:39
Men snarare att, okej, men här finns saker som ledde upp till det här.
00:15:45
Eller saker vi ska komma ihåg.
00:15:47
Får bara ner det någonstans så kan vi förbättra det sen i sådana fall.
00:15:51
Ja, men precis.
00:15:53
Ja, jag tycker också att det är intressant det där, vad som gör bra dokumentation.
00:15:59
Alltså både oavsett om det är i en ticket, eller om man skriver i en readme-fil, eller om det är på hemsidan för ett bibliotek.
00:16:07
Alltså det är liksom, jag har svårt att spesa exakt vad som gör att jag tycker att det här är bra dokumentation.
00:16:14
Alltså jag har liksom ingen checklista som jag skulle kunna fylla i.
00:16:17
Nej, inte jag heller. Men det beror ju extremt mycket på. Jag menar en readme.
00:16:22
Så att du ska starta upp ett projekt som inte har några konstiga grejer eller behöver sätta en...
00:16:29
Alltså det är ju toppen om du behöver ha den här enven och då hämtar du via det här systemet genom att sätta den här.
00:16:33
Annars är det typ "yarn start".
00:16:36
Ja.
00:16:36
Och då behöver man inte skriva jättemycket mer som ingen orkar läsa om ingen läser det.
00:16:42
Och det är ju för egna projekt, småprojekt.
00:16:45
Jag menar, jag tycker det är ju...
00:16:47
Allt ska ju stå i en readme om det är något lib jag vill använda.
00:16:51
Jag vill ha mer information i det, liksom. Jag vill ha allt.
00:16:53
Ja, jag har precis. För du var ju till exempel inne på lite tidigare det här med typ att en API-referens bara.
00:17:01
Det skulle jag tycka att om det är det enda som finns, då är det ganska dålig dokumentation.
00:17:04
Alltså om du har ett bibliotek och så bara "Ja, men du kan se vilka API vi har och vi har dokumenterat dem"
00:17:08
och det står typ så här.
00:17:10
"Den tar emot de här parametrarna, spottar ut sig i det här."
00:17:13
Klart.
00:17:15
Den skulle jag förmodligen tycka är ganska dålig. Det beror lite på vad det är.
00:17:18
Jag kan tänka mig typ, om vi tar Lodash eller Underscore eller vad alla nu heter.
00:17:23
Där funkar det lite bättre för att det är typ utility-funktioner.
00:17:26
Men tittar man på Reacts dokumentation eller Vues dokumentation, då vill jag gärna ha-
00:17:31
-mer saker som förklarar idéerna bakom och hur man ska tänka och sådana saker också.
00:17:37
Ja, men jag skulle ändå vilja ha en tydlig sida där de bara spesar allting.
00:17:43
För om jag är bekant med ett bibliotek och använder det, då vill jag kunna ha kortkommandon.
00:17:48
Jag hänger mycket i dokumentation bara för att jag inte kommer ihåg.
00:17:52
Ja, exakt. Det kanske är lite olika syften med de sidorna.
00:17:55
API-specifikationen kanske mer är referens eller API-referens.
00:17:59
Alltså att du går in dit och bara refererar till saker du vet vad finns, men du behöver bara dubbelkolla hur det funkar.
00:18:03
Medan annan typ av dokumentation som hur man ska tänka i React till exempel.
00:18:09
Den är ju mer om man kanske är ny inom det paradigmet eller språket eller vad det nu kan vara man dokumenterar.
00:18:19
Ja, jag gillar ju verkligen när det finns ofta en "get started" eller någonting som har lite grundläggande tyngd och information.
00:18:26
De tycker ofta att kanske... Ett problem jag tycker med dokumentation ibland som jag känner igen mig väldigt mycket från när jag började koda överhuvudtaget
00:18:33
Jag tycker att det är två nivåer. Du har saker som är dokumenterat eller förklarat på en extremt låg nivå.
00:18:47
Det här är kod, det här är en for loop.
00:18:51
Alltså, du förstår min grej. Den är extremt, liksom, här är bara grunderna.
00:18:58
Och sen så tycker jag att hoppet till att bara göra antagandet, att du förstår allting som ska vara däremellan, kommer väldigt tidigt.
00:19:05
Jag har alltid känt att det är väldigt svårt att hitta köttet i mitten.
00:19:10
Och på det tycker jag är lite samma sak ibland med sådana här "get started".
00:19:13
Okej, här får du de första exemplen och här är hela API-referensen.
00:19:17
Men så fort jag går på lite mer komplexa delar, vart står det? Hur hittar jag det?
00:19:23
Absolut, det är väldigt sant att det är ofta basics eller avancerat.
00:19:29
Det är inte så mycket "intermediate" säger man på engelska. Jag kommer inte på något svenskt ord.
00:19:34
Ja, extremt mycket kortare sätt att beskriva det på än vad jag gjorde.
00:19:37
Nej, jag samfattade bara vad du sa.
00:19:41
Eftersom jag inte kan dra ut gisten i saker, då får du göra det åt mig.
00:19:45
Jag får öva på det nu.
00:19:47
Nej men precis, jag håller med om det.
00:19:50
Ofta hittar man det här mellan-steget.
00:19:54
Och det är väl lite steget som tutorials eller guider fyller.
00:19:59
Att någon håller dig i handen medan du försöker använda det du kan från basics för att komma till det som är avancerat.
00:20:08
Så det kanske är lite så, men det är också sällan jag ser själva biblioteken eller upphovspersonerna bakom har de här guiderna.
00:20:23
Oftast är det ju att communityt steppar upp och försöker skriva de här guiderna eller tutorials eller vad det nu kan vara.
00:20:29
Och liksom fyller den luckan kanske.
00:20:31
Visst, det funkar ju, men det känns samtidigt som att det kanske behövs lite mer som faktiskt
00:20:37
officiell dokumentation för vissa saker som bara fyller den mittendelen också.
00:20:43
Ja, jag antar att det också är den som är svårast att få ner på något sätt.
00:20:50
Här börjar du och här upplever du referenserna, men det här svåra i mitten är väl...
00:20:54
För jag antar att de som skriver de här posterna, de har nog inte bara "Jag bara gjorde det, allt var lugnt, allt var fin".
00:21:02
Det har nog svettats en del för att komma fram till de här grejerna.
00:21:06
– Ja, verkligen.
00:21:07
Nej, jag tror att det är svårt.
00:21:11
Jag har ändå några "drafts" på min sajt.
00:21:16
Det är typ så här "Hur du bygger en rit-app med React".
00:21:20
Typ, eller något.
00:21:23
Och sen har jag spesat ner vad som behöver innehållas här och så bara "Oj, vad mycket det blev!"
00:21:28
"Det här orkar inte jag skriva."
00:21:30
"Det kommer vara svårt att få det på en bra nivå och konsekvent språk."
00:21:36
"Att det inte blir tråkigt, att det inte blir utdraget och så vidare."
00:21:38
Så jag förstår verkligen att det kan tänkas vara svårt.
00:21:43
- Ja.
00:21:45
Men ja, dokumentation blir ju också...
00:21:48
Det blir ju mycket lättare att få till om man har bra verktyg för att göra det.
00:21:53
Jag kommer ihåg att jag byggde en tjänstagång.
00:21:55
Som jag sen då skulle, alltså det var bara en pock.
00:21:59
Och sen så skulle jag lämna projektet liksom.
00:22:02
Och så skulle jag dokumentera det.
00:22:04
I ett dokumentationssystem som var så otroligt bra.
00:22:10
Och jag menar det var ju ett fullt team som satt och jobbade med det.
00:22:13
Så det var inte så att det bara fanns.
00:22:15
Men det var liksom något sådär Python, Markdown baserat liksom.
00:22:21
Det var helt magiskt att skriva saker i och kunna lägga in bilder och bygga grafer.
00:22:29
Det gick ju undan, men det är också ett väldigt litet isolerat system där jag bara skulle försöka få ner allt och lämna vidare det.
00:22:36
- Men det var något internt system på just det där bolaget som de hade byggt för att dokumentera saker?
00:22:41
- Ja, precis.
00:22:43
Det finns ju ändå lite försök att göra det här.
00:22:47
Du har ju till exempel Storybook, är väl kanske en del av det här, lite mer upp i referens fast för komponenter.
00:22:54
Som försöker vi prata om i en tidigare avsnitt också.
00:22:57
Men sen finns det också Docosaurus, är väl något open source bibliotek, eller ramverk kanske.
00:23:04
Som man kan skriva dokumentation i. Jag tror att det är Facebook som ligger bakom det också, eller om de har köpt upp det eller något.
00:23:09
Det är också tänkt för att man ska kunna dokumentera saker.
00:23:16
En sak jag tänker på nu är att älska den nya vågen, eller nya...
00:23:22
Inte så nya idéer, men att folk har börjat integrera mer interaktiva element i dokumentation.
00:23:31
Alltså att du faktiskt kan klicka runt och känna hur nånting känns, eller att du kan skriva koden
00:23:36
Och sen se resultat direkt i dokumentationen eller att du kan typ redigera kodexempel och de liksom uppdaterar faktiskt vad som resultatet blir också.
00:23:45
Det känns jävligt bra tycker jag.
00:23:48
Ja, men det är ju väldigt Mozilla. De var ju tidiga.
00:23:54
MDN.
00:23:55
Ja, men precis.
00:23:57
Och jag vet till exempel.
00:24:01
Nu ska vi se vad det heter för något. Code Sandbox har ju släppt något verktyg som är gjort just för att kunna köra liksom.
00:24:08
Eller för att kunna, vad ska man säga, kompilera kod i browserna eller transpilera eller vad man nu vill kalla det.
00:24:15
Som heter, heter det Snowpack? Eller bland ihop med något annat?
00:24:19
- Var inte Snowpack det här när du skulle kunna dra in typ Endances i runtime?
00:24:23
- Jo, det kan vara. Det heter antingen Snowpack, det heter kanske Sandpack?
00:24:29
Får jag för mig?
00:24:31
Ja, det heter Sandpack.
00:24:35
Jag gissar på att det egentligen är en blandning av att det andra heter Snowpack och det här blir Sand.
00:24:41
Och att det kommer från kod Sandbox, gissar jag.
00:24:45
Bra förklaring.
00:24:47
Ja, precis. Så det är liksom något bibliotek som du kan köra kod i webbläsaren som du skriver i webbläsaren.
00:24:55
Sånt gör ju dokumentationen så mycket roligare att läsa att man kan experimentera lite grann med den.
00:25:01
För min del blir det så mycket enklare att lära sig saker när jag faktiskt kan testa lite och förstöra det och se vad som händer när man ändrar på saker.
00:25:08
Fan det är också intressant för jag är sådärn.
00:25:12
Nej men det där, det där ska jag inte pilla med.
00:25:16
Du vill gärna bara ha, okej säg åt mig vad som är rätt och sen rör inte jag det.
00:25:24
Jag tror inte det, det är ju fan ingenting. Jag är så otroligt hämmad av min egen ängslighet.
00:25:32
Jag vet inte vad jag håller på med.
00:25:35
Nej, det känns ändå som att du skulle kunna ändra på och lära dig lite lättare.
00:25:43
Jag vet inte, det är ju personligt också hur man lär sig.
00:25:45
Det är samma sak som folk som föredrar att lära sig via video, text eller att göra själv.
00:25:52
Det är dumt, vi är en extremt visuell människa egentligen.
00:25:56
Och fattar inte när jag inte får se saker. Så det måste jag börja använda.
00:26:00
Jag tycker det verkar väldigt nice. Jag tror, minns inte om ni gör React-docs-sajten.
00:26:06
Använder ju Sandpack, eller om det kom senare, jag vet faktiskt inte.
00:26:10
Men de har ju också ganska mycket interaktiva exempel på, där man kan se hur saker bedir.
00:26:15
När man faktiskt har en komponent och allting sånt.
00:26:18
Jag tror att den trenden är väldigt positivt framåt för alla.
00:26:25
Ja, men det är intressant. Vilken dokumentation tror du att du använder dig mest av in life?
00:26:37
Jag vet inte, det är så jävla svårt.
00:26:41
Views-dokumentation har ju varit extremt bra väldigt länge.
00:26:44
Och det känns som att många andra har spelat catch-up med views-dokumentationen för att komma ikapp den nivån.
00:26:53
Jag vet att när jag lärde mig Views från början så satt jag nästan bara i dokumentationen.
00:26:57
För att den var så extremt bra. De hade mycket exempel.
00:27:00
De hade en cookbook kanske, där de hade tagit fram ganska komplexa exempel på hur man kan göra saker och rekommenderade lösningar på det.
00:27:10
Så den satt jag och läste extremt mycket när jag lärde mig Vue.
00:27:14
Men sedan har jag hållit på med React så pass länge nu att jag kanske har läst Reacts dokumentation mer.
00:27:19
Men sen är det också svårt, det kan ju vara att man är in på MDN och läser om JavaScript.
00:27:24
Det händer ju också väldigt ofta.
00:27:27
Så jag tror det är svårt att säga, men MDN ligger nog där uppe i topp i alla fall.
00:27:31
Blandat med något ramverksdokumentation.
00:27:35
Har du någon som du känner "ja, den har jag varit in på så jävla mycket"?
00:27:38
Nej, du är ju helt baserad på vad jag jobbar med.
00:27:44
På senaste, av någon anledning så har jag blivit helt okej på MongoDB aggregation pipeline.
00:27:53
Det är ganska nischat.
00:27:55
Ja, det är ganska nischat.
00:27:57
Där hänger ju en del för att hitta saker.
00:28:01
Men det är också kul för att någonting som jag alltid återkommer till det är gästs dokumentation.
00:28:06
Och det är ju också, det har ju gått till en nivå där jag blir lite arg för att jag har hängt i, alltså det är alltid problem med att mocka saker.
00:28:18
Ja det gäller det.
00:28:20
Och då hänger jag i en mockdokumentation och så är det alltid det här jäkla happy exemplet med en sound player.
00:28:30
Jag är alltid lite arg när jag läser det här.
00:28:33
Det är som att jag blir lite tryggad av att jag igen måste titta på Soundplay-exemplet.
00:28:38
För att jag igen har problem med att mocka.
00:28:41
Så det väcker känslor.
00:28:43
Ja, det förstår jag. Det var ganska länge sedan jag var inne i S-dokumentation nu tror jag.
00:28:46
Men jag har en känsla för att jag inte tyckte det var så bra.
00:28:49
Men det kanske är bara för att det fanns så många olika saker som lät typ likadant.
00:28:53
Som jag inte riktigt vet vad skillnaden är på.
00:28:55
Och så hittade man ingenting och slutade med att man hamnade på stack over.
00:28:59
Och så ser man vad det blir av det.
00:29:02
Jo men absolut, absolut. Så tycker jag också att det är.
00:29:05
Men sen har ju stack-ovarna liksom bara så här
00:29:08
"Ah, men det här exemplet med en sound player, och då?"
00:29:12
[Skratt]
00:29:15
Ja, det är inte lätt alla gånger att hitta rätt.
00:29:20
Nej, men alltså sen så om jag ska säga vilka som hänger med.
00:29:24
MDN hänger ju en del in på.
00:29:26
Och sen så hamnar alltid V3 Schools uppe bland mina sökningar.
00:29:32
Och sen var det väl någon gång då någon sa "där ska man inte vara inne".
00:29:36
Så jag gör mitt allra yttersta för att hitta en annan träff.
00:29:39
Men ibland så är jag bara för trött för att jag bara vet att jag ska kolla någon syntax.
00:29:42
Så jag hänger där en del också.
00:29:44
- Ja, men de var väl liksom the go-to back in the days.
00:29:47
Jag vet att ni har byggt en klanhemsida när jag var 15 år sedan.
00:29:53
Då var det ju V3 Schools som var dit man gick, det var där man lärde sig saker.
00:29:57
Men sen hade de väl ganska mycket felaktig information framför mig.
00:30:03
Alltså dåliga råd på deras sida och grejer, så det var extremt dålig kvalitet på deras dokumentation ett tag.
00:30:09
Nu tror jag faktiskt att den är bättre.
00:30:11
Jag har inte varit i någon dubbelkolla där själv, men jag har hört folk säga att de har ryckt upp sig så nu är den bättre än förut.
00:30:16
Men de har ju en jävligt bra SEO-sida så att de hamnar ju ofta högst upp i resultatet när man söker på saker.
00:30:25
Ja, den måste vara så himla bra.
00:30:29
Men det är ju ofta när man ska kolla så här.
00:30:31
Jag borde inte trycka här, men jag orkar inte. Det är bara en syntaxgrej. Jag går in här.
00:30:37
Det är också lite nostalgiskt att gå in där. Den har väl sett likadan ut i 15 år?
00:30:41
Ja, säkert.
00:30:45
Det är kanske där vi lämnar våra lyssnare med idag. Gå in på V3 Schools. Få en liten nostalgi-trip om du ser likadant hur länge som helst.
00:30:53
Så att det kanske är helt nytt utseende.
00:30:56
Jag var nog inne förra veckan. Jag tror det är ganska likt.
00:31:00
Med det sagt så tackar vi för oss den här gången och vi hörs igen om två veckor.
00:31:09
Det gör vi. Ha det bra. Bye bye.
00:31:12
[Outromusik]
Tillbaka upp